` em todas as demais chamadas. |\n| `id_token` | `String` | Token informativo sobre a identidade autenticada. Não é aceito em nenhuma outra operação da API. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `INVALID_CREDENTIALS_ERROR` | Usuário/senha incorretos, conta inexistente ou loja associada bloqueada. | Reapresente credenciais corretas. Se o erro persistir com credenciais que você sabe estarem corretas, contate o suporte Unbox (a loja pode estar bloqueada). |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n>\n> **Gotcha:** para `signIn`, o código do erro (ex.: `INVALID_CREDENTIALS_ERROR`) vem em `errors[].message`. O campo `errors[].extensions.code` desta operação **não** carrega o código específico — trate-o como não confiável para decisão de fluxo em `signIn` e faça o parsing do erro por `message`.\n\n### Notas\n\n- O `id_token` não substitui o `access_token`: use sempre `access_token` no header `Authorization` das demais chamadas.\n- Credenciais inválidas e loja bloqueada são indistinguíveis na resposta (mesmo código) por design — não construa lógica de retry/diagnóstico que dependa de diferenciá-los.\n- Não há expiração informada no retorno; trate um novo `INVALID_CREDENTIALS_ERROR`/falha de autorização em operações subsequentes como sinal para chamar `signIn` novamente."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"errors\": [\n {\n \"message\": \"User account metadata update error\",\n \"extensions\": {\n \"code\": \"USER_ACCOUNT_METADATA_UPDATE_ERROR\"\n }\n }\n ]\n}"}],"_postman_id":"5ecb9986-e277-5637-9077-f85ec9db5e6f"}],"id":"82e819bb-f61d-4e60-8c78-6bccda9718e8","_postman_id":"82e819bb-f61d-4e60-8c78-6bccda9718e8","description":""}],"id":"6f3f81ae-817d-403d-9ed9-3e002bd0a3c9","description":"Autenticação
\nDomínio responsável por autenticar parceiros na API. Hoje expõe uma única operação, signIn, que troca usuário e senha por um access_token válido para todas as demais chamadas da API de parceiros.
\nFluxo de autenticação
\n\n- Chame a mutation
signIn enviando username e password da conta parceira, junto com o header obrigatório x-api-key (ver tabela abaixo). \n- Em caso de sucesso,
signIn retorna access_token e id_token. Use o access_token; o id_token é apenas informativo e não é aceito em nenhuma outra operação. \n- Envie o
access_token no header Authorization: <access_token> em toda chamada seguinte. Envie o token puro, sem o prefixo Bearer — prefixá-lo quebra a autenticação. \n- O
access_token expira. Não há uma operação de \"refresh\" separada — quando expirar, chame signIn novamente para obter um novo par de tokens. \n
\n\n\n\n\n| Header | \nUso | \nObrigatório em | \n
\n\n\n\nx-api-key | \nIdentifica seu app/consumidor na API | \nTodas as chamadas, incluindo signIn | \n
\n\nAuthorization | \n<access_token> obtido via signIn | \nTodas as chamadas exceto signIn | \n
\n\n
\n
shopId derivado do token
\nA partir do access_token obtido em signIn, várias operações da API deixam de exigir o argumento shopId: ele é derivado automaticamente do seu token no momento da chamada. Nessas operações você não envia (e não consegue enviar) shopId explicitamente — basta autenticar com o Authorization correto. Cada operação afetada documenta isso individualmente na sua própria página.
\nRegras de negócio
\n\nsignIn pode ser chamado quantas vezes forem necessárias com as mesmas credenciais; cada chamada gera um novo par de tokens, sem efeito colateral negativo em chamadas repetidas.- Por segurança, credenciais inválidas, conta inexistente e conta de loja bloqueada retornam o mesmo código de erro (
INVALID_CREDENTIALS_ERROR) — a resposta não diferencia o motivo exato. \n- Erros de negócio em
signIn chegam com HTTP 200 e um array errors[], como em toda a API. Para este domínio, valide o erro por errors[].message — ver detalhes e gotcha específico na página da operação. \n
\n","_postman_id":"6f3f81ae-817d-403d-9ed9-3e002bd0a3c9"},{"name":"Carts","item":[{"name":"Query","item":[{"name":"[Query] cartTemplate","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns cartTemplate data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"cartTemplate\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"cartTemplate returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.cartTemplate;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"referenceId\");"," if (data.referenceId !== undefined && data.referenceId !== null) {"," pm.expect(typeof data.referenceId).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"type\");"," if (data.type !== undefined && data.type !== null) {"," pm.expect(typeof data.type).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"shopId\");"," if (data.shopId !== undefined && data.shopId !== null) {"," pm.expect(typeof data.shopId).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.updatedAt !== undefined && data.updatedAt !== null) {"," pm.expect(typeof data.updatedAt).to.equal(\"string\");"," }"," if (data.updatedAt) {"," pm.expect(new Date(data.updatedAt).toString()).to.not.equal(\"Invalid Date\");"," }"," pm.expect(data).to.have.property(\"title\");"," if (data.title !== undefined && data.title !== null) {"," pm.expect(typeof data.title).to.equal(\"string\");"," }"," if (data.createdBy !== undefined && data.createdBy !== null) {"," pm.expect(typeof data.createdBy).to.equal(\"string\");"," }"," if (data.updatedBy !== undefined && data.updatedBy !== null) {"," pm.expect(typeof data.updatedBy).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"totalAmount\");"," if (data.totalAmount !== undefined && data.totalAmount !== null) {"," pm.expect(typeof data.totalAmount).to.equal(\"number\");"," }"," }","});"]}}],"id":"11f7810b-c1b6-5ab5-9a39-dd5fc82c8dfe","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplate($cartTemplateId: ID!) {\n cartTemplate(cartTemplateId: $cartTemplateId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartTemplateId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"cartTemplate
\nPropósito: Retorna um único template de carrinho pelo _id.\nQuando usar: Para consultar os detalhes de um template específico antes de usá-lo em createCartByTemplate, ou para conferir seu estado (status, isSoldOut, isExpired) — use quando você já tem o _id. Para buscar por outros critérios, use cartTemplates.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ncartTemplateId | \nID! | \nSim | \n— | \n_id do template de carrinho a buscar. | \n
\n\n
\n
Retorno
\nCartTemplate:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nIdentificador do template. | \n
\n\nreferenceId | \nString! | \nIdentificador legível, único por loja. | \n
\n\ntitle | \nString! | \nTítulo do template. | \n
\n\nstatus | \nCartTemplateStatus! | \nACTIVE ou PAUSED. Templates PAUSED não podem ser usados em createCartByTemplate (ver Erros nessa operação). | \n
\n\nisSoldOut | \nBoolean! | \ntrue quando constraints.usageLimit está definido e ordersCount já atingiu esse limite. Calculado a cada consulta. | \n
\n\nisExpired | \nBoolean! | \ntrue quando a data atual passou de constraints.expirationDate. Calculado a cada consulta. | \n
\n\ntotalAmount | \nMoney! | \nSoma do preço atual no catálogo dos itens do template × quantidade — recalculada a cada consulta, não congelada no momento da criação. | \n
\n\nitems | \n[CartTemplateItem!]! | \nItens do template. Cada item traz product, variant/variants, quantity, isRecurring, isVisible. Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente (o array pode vir mais curto que o originalmente configurado). | \n
\n\ndiscount | \nDiscount | \nCódigo de desconto vinculado ao template, se houver. | \n
\n\nrecurringItemsFrequency | \nRecurringOrderFrequency | \nFrequência de recorrência vinculada, se recurringItemsFrequencyId estiver configurado; null caso contrário ou se a frequência não existir mais entre as permitidas pela loja. | \n
\n\nshipping | \nCartTemplateShipping | \nfulfillmentType, fulfillmentOptions, shippingValue configurados no template. | \n
\n\nconstraints | \nCheckoutTemplateConstraints | \nusageLimit, expirationDate. | \n
\n\nordersCount | \nInt | \nQuantidade de carrinhos já criados a partir deste template. | \n
\n\npaymentMethod | \nPaymentMethodName | \nForma de pagamento vinculada ao template, se aplicável. | \n
\n\nblockPaymentMethodChange | \nBoolean | \nSe true, o carrinho criado a partir deste template não permite trocar a forma de pagamento. | \n
\n\nblockApplyDiscountCode | \nBoolean | \nSe true, códigos de desconto não podem ser aplicados ao carrinho criado a partir deste template. | \n
\n\nblockApplyShopSale | \nBoolean | \nSe true, promoções da loja não são aplicadas automaticamente ao carrinho. | \n
\n\ncreatedAt / updatedAt | \nAWSDateTime! / AWSDateTime | \nDatas de criação/atualização. | \n
\n\ncreatedBy / updatedBy | \nString | \nIdentificador de quem criou/atualizou o template. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nCART_TEMPLATE_NOT_FOUND_ERROR | \nNão existe template não-excluído com o cartTemplateId informado na sua loja. | \nConfira se o _id está correto e se o template pertence à loja autenticada. | \n
\n\n| (sem código) | \nAutenticação/permissão ausente ou inválida: a mensagem começa com \"Unauthorized\". | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Não retorna
null quando não encontrado — lança erro. Apesar do tipo de retorno (CartTemplate, sem !) sugerir que a query poderia devolver null para um ID inexistente, o comportamento real é lançar CART_TEMPLATE_NOT_FOUND_ERROR. Trate \"não encontrado\" como item em errors[], não como data.cartTemplate: null. \ntotalAmount reflete o preço de hoje no catálogo, não o preço de quando o template foi criado. Se você precisa saber o valor exato que será cobrado ao criar o carrinho, consulte novamente antes de chamar createCartByTemplate — o preço pode ter mudado desde a última consulta.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b7c5fe63-1ecc-4cb7-9bf4-9f52f4b94c03","name":"200 - cartTemplate","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplate($cartTemplateId: ID!) {\n cartTemplate(cartTemplateId: $cartTemplateId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartTemplateId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## cartTemplate\n\n**Propósito:** Retorna um único template de carrinho pelo `_id`.\n**Quando usar:** Para consultar os detalhes de um template específico antes de usá-lo em `createCartByTemplate`, ou para conferir seu estado (`status`, `isSoldOut`, `isExpired`) — use quando você já tem o `_id`. Para buscar por outros critérios, use `cartTemplates`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ---- | ----------- | ------- | --------------------------------------- |\n| `cartTemplateId` | ID! | Sim | — | `_id` do template de carrinho a buscar. |\n\n### Retorno\n\n`CartTemplate`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do template. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `title` | `String!` | Título do template. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. Templates `PAUSED` não podem ser usados em `createCartByTemplate` (ver Erros nessa operação). |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e `ordersCount` já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma do preço **atual no catálogo** dos itens do template × quantidade — recalculada a cada consulta, não congelada no momento da criação. |\n| `items` | `[CartTemplateItem!]!` | Itens do template. Cada item traz `product`, `variant`/`variants`, `quantity`, `isRecurring`, `isVisible`. Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente (o array pode vir mais curto que o originalmente configurado). |\n| `discount` | `Discount` | Código de desconto vinculado ao template, se houver. |\n| `recurringItemsFrequency` | `RecurringOrderFrequency` | Frequência de recorrência vinculada, se `recurringItemsFrequencyId` estiver configurado; `null` caso contrário ou se a frequência não existir mais entre as permitidas pela loja. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no template. |\n| `constraints` | `CheckoutTemplateConstraints` | `usageLimit`, `expirationDate`. |\n| `ordersCount` | `Int` | Quantidade de carrinhos já criados a partir deste template. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao template, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o carrinho criado a partir deste template não permite trocar a forma de pagamento. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados ao carrinho criado a partir deste template. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente ao carrinho. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n| `createdBy` / `updatedBy` | `String` | Identificador de quem criou/atualizou o template. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| `CART_TEMPLATE_NOT_FOUND_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja. | Confira se o `_id` está correto e se o template pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`CartTemplate`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `CART_TEMPLATE_NOT_FOUND_ERROR`. Trate \"não encontrado\" como item em `errors[]`, não como `data.cartTemplate: null`.\n- **`totalAmount` reflete o preço de hoje no catálogo, não o preço de quando o template foi criado.** Se você precisa saber o valor exato que será cobrado ao criar o carrinho, consulte novamente antes de chamar `createCartByTemplate` — o preço pode ter mudado desde a última consulta."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cartTemplate\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"totalAmount\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"ordersCount\": 10,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\"\n },\n \"items\": [\n {\n \"quantity\": 1,\n \"isRecurring\": true,\n \"isVisible\": true\n }\n ],\n \"discount\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n },\n \"recurringItemsFrequency\": {\n \"_id\": \"Example_String\",\n \"title\": \"Example_String\",\n \"periodicity\": \"DAY\",\n \"interval\": 10\n },\n \"paymentMethod\": {},\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n}"},{"id":"c924aba6-d654-44e1-8d34-2228cbe8d6d8","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplate($cartTemplateId: ID!) {\n cartTemplate(cartTemplateId: $cartTemplateId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartTemplateId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## cartTemplate\n\n**Propósito:** Retorna um único template de carrinho pelo `_id`.\n**Quando usar:** Para consultar os detalhes de um template específico antes de usá-lo em `createCartByTemplate`, ou para conferir seu estado (`status`, `isSoldOut`, `isExpired`) — use quando você já tem o `_id`. Para buscar por outros critérios, use `cartTemplates`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ---- | ----------- | ------- | --------------------------------------- |\n| `cartTemplateId` | ID! | Sim | — | `_id` do template de carrinho a buscar. |\n\n### Retorno\n\n`CartTemplate`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do template. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `title` | `String!` | Título do template. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. Templates `PAUSED` não podem ser usados em `createCartByTemplate` (ver Erros nessa operação). |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e `ordersCount` já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma do preço **atual no catálogo** dos itens do template × quantidade — recalculada a cada consulta, não congelada no momento da criação. |\n| `items` | `[CartTemplateItem!]!` | Itens do template. Cada item traz `product`, `variant`/`variants`, `quantity`, `isRecurring`, `isVisible`. Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente (o array pode vir mais curto que o originalmente configurado). |\n| `discount` | `Discount` | Código de desconto vinculado ao template, se houver. |\n| `recurringItemsFrequency` | `RecurringOrderFrequency` | Frequência de recorrência vinculada, se `recurringItemsFrequencyId` estiver configurado; `null` caso contrário ou se a frequência não existir mais entre as permitidas pela loja. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no template. |\n| `constraints` | `CheckoutTemplateConstraints` | `usageLimit`, `expirationDate`. |\n| `ordersCount` | `Int` | Quantidade de carrinhos já criados a partir deste template. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao template, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o carrinho criado a partir deste template não permite trocar a forma de pagamento. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados ao carrinho criado a partir deste template. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente ao carrinho. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n| `createdBy` / `updatedBy` | `String` | Identificador de quem criou/atualizou o template. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| `CART_TEMPLATE_NOT_FOUND_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja. | Confira se o `_id` está correto e se o template pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`CartTemplate`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `CART_TEMPLATE_NOT_FOUND_ERROR`. Trate \"não encontrado\" como item em `errors[]`, não como `data.cartTemplate: null`.\n- **`totalAmount` reflete o preço de hoje no catálogo, não o preço de quando o template foi criado.** Se você precisa saber o valor exato que será cobrado ao criar o carrinho, consulte novamente antes de chamar `createCartByTemplate` — o preço pode ter mudado desde a última consulta."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"824b41c2-ea96-45ad-83fe-d65b04bdd147","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplate($cartTemplateId: ID!) {\n cartTemplate(cartTemplateId: $cartTemplateId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartTemplateId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## cartTemplate\n\n**Propósito:** Retorna um único template de carrinho pelo `_id`.\n**Quando usar:** Para consultar os detalhes de um template específico antes de usá-lo em `createCartByTemplate`, ou para conferir seu estado (`status`, `isSoldOut`, `isExpired`) — use quando você já tem o `_id`. Para buscar por outros critérios, use `cartTemplates`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ---- | ----------- | ------- | --------------------------------------- |\n| `cartTemplateId` | ID! | Sim | — | `_id` do template de carrinho a buscar. |\n\n### Retorno\n\n`CartTemplate`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do template. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `title` | `String!` | Título do template. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. Templates `PAUSED` não podem ser usados em `createCartByTemplate` (ver Erros nessa operação). |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e `ordersCount` já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma do preço **atual no catálogo** dos itens do template × quantidade — recalculada a cada consulta, não congelada no momento da criação. |\n| `items` | `[CartTemplateItem!]!` | Itens do template. Cada item traz `product`, `variant`/`variants`, `quantity`, `isRecurring`, `isVisible`. Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente (o array pode vir mais curto que o originalmente configurado). |\n| `discount` | `Discount` | Código de desconto vinculado ao template, se houver. |\n| `recurringItemsFrequency` | `RecurringOrderFrequency` | Frequência de recorrência vinculada, se `recurringItemsFrequencyId` estiver configurado; `null` caso contrário ou se a frequência não existir mais entre as permitidas pela loja. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no template. |\n| `constraints` | `CheckoutTemplateConstraints` | `usageLimit`, `expirationDate`. |\n| `ordersCount` | `Int` | Quantidade de carrinhos já criados a partir deste template. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao template, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o carrinho criado a partir deste template não permite trocar a forma de pagamento. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados ao carrinho criado a partir deste template. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente ao carrinho. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n| `createdBy` / `updatedBy` | `String` | Identificador de quem criou/atualizou o template. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |\n| `CART_TEMPLATE_NOT_FOUND_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja. | Confira se o `_id` está correto e se o template pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`CartTemplate`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `CART_TEMPLATE_NOT_FOUND_ERROR`. Trate \"não encontrado\" como item em `errors[]`, não como `data.cartTemplate: null`.\n- **`totalAmount` reflete o preço de hoje no catálogo, não o preço de quando o template foi criado.** Se você precisa saber o valor exato que será cobrado ao criar o carrinho, consulte novamente antes de chamar `createCartByTemplate` — o preço pode ter mudado desde a última consulta."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"11f7810b-c1b6-5ab5-9a39-dd5fc82c8dfe"},{"name":"[Query] cartTemplates","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns cartTemplates data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"cartTemplates\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"cartTemplates returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.cartTemplates;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"e4e421df-f343-54b7-8f80-2ba9eae3fc8e","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplates($filters: CartTemplateFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: CartTemplateSortByField) {\n cartTemplates(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"cartTemplates
\nPropósito: Lista os templates de carrinho da sua loja, com filtros e paginação Relay.\nQuando usar: Para escolher qual template usar em createCartByTemplate sem precisar guardar o _id de cada um — filtre por status, período ou texto livre. Para buscar um único template já conhecido, use cartTemplate.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nCartTemplateFilterInput | \nNão | \n— | \nVer tabela de filtros abaixo. | \n
\n\nafter / before | \nString | \nNão | \n— | \nCursor Relay para paginação para frente/para trás. | \n
\n\nfirst / last | \nInt (1–50) | \nNão | \n20 (se nenhum for enviado) | \nTamanho da página. Envie apenas um dos dois — first com after, ou last com before. | \n
\n\noffset | \nInt | \nNão | \n— | \nPula os N primeiros resultados. Pode ser combinado com first. | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nasc ou desc. | \n
\n\nsortBy | \nCartTemplateSortByField | \nNão | \nCREATED_AT | \nTITLE, CREATED_AT, EXPIRATION_DATE, STATUS. | \n
\n\n
\n
\n\n\n| Nome | \nTipo | \nDescrição | \n
\n\n\n\ntitle | \nString | \nFiltro por título, contendo o texto (case-insensitive). | \n
\n\ntextQuery | \nString | \nBusca livre que casa contra title ou referenceId (case-insensitive). | \n
\n\nstatus | \n[CartTemplateStatus] | \nRestringe a uma ou mais das opções ACTIVE, PAUSED. | \n
\n\nisSoldOut | \nBoolean | \nFiltra pelo valor calculado de isSoldOut (ver folder para como é calculado). | \n
\n\nisExpired | \nBoolean | \nFiltra pelo valor calculado de isExpired. | \n
\n\ncreatedAt | \nDateFilterInput | \n{ gte, lte } em AWSDateTime, ambos opcionais. | \n
\n\nexpirationDate | \nDateFilterInput | \nMesma forma de createdAt, aplicada à data de expiração configurada em constraints.expirationDate. | \n
\n\n
\n
Diferente de paymentLinks, este filtro não tem fulfillmentTypes.
\nRetorno
\nCartTemplateConnection!:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes | \n[CartTemplate] | \nLista de templates — mesma forma retornada por cartTemplate. | \n
\n\nedges | \n[CartTemplateEdge] | \n{ cursor, node }, para clientes que paginam via cursor por edge em vez de nodes diretamente. | \n
\n\npageInfo | \nPageInfo! | \nhasNextPage, hasPreviousPage, startCursor, endCursor. | \n
\n\ntotalCount | \nInt! | \nTotal de templates que casam com os filtros, ignorando paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nfirst e last enviados juntos. | \nEnvie apenas um dos dois. | \n
\n\n| (sem código) | \nfirst/last fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | \nCorrija o valor conforme a tabela de argumentos; verifique message do erro. | \n
\n\n| (sem código) | \nAutenticação/permissão ausente ou inválida: a mensagem começa com \"Unauthorized\". | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Erros de validação de argumentos não carregam um extensions.code estável — confira sempre message.
\n
\nNotas
\n\ntotalAmount de cada item é recalculado do preço atual do catálogo, não congelado no momento da criação do template (diferente de paymentLinks). Ver a página do folder Carrinhos para o detalhe completo dessa diferença.- Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente de
items[] em cada template retornado. \n- Sem
first/last, o tamanho de página padrão é 20. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cca717a9-1475-476c-8023-88a0b9291a7f","name":"200 - cartTemplates","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplates($filters: CartTemplateFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: CartTemplateSortByField) {\n cartTemplates(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## cartTemplates\n\n**Propósito:** Lista os templates de carrinho da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para escolher qual template usar em `createCartByTemplate` sem precisar guardar o `_id` de cada um — filtre por status, período ou texto livre. Para buscar um único template já conhecido, use `cartTemplate`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------- | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `CartTemplateFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `CartTemplateSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`CartTemplateFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ---------------- | ---------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[CartTemplateStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n\nDiferente de `paymentLinks`, este filtro **não** tem `fulfillmentTypes`.\n\n### Retorno\n\n`CartTemplateConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | -------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[CartTemplate]` | Lista de templates — mesma forma retornada por `cartTemplate`. |\n| `edges` | `[CartTemplateEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de templates que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **`totalAmount` de cada item é recalculado do preço atual do catálogo**, não congelado no momento da criação do template (diferente de `paymentLinks`). Ver a página do folder **Carrinhos** para o detalhe completo dessa diferença.\n- Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente de `items[]` em cada template retornado.\n- Sem `first`/`last`, o tamanho de página padrão é 20."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"cartTemplates\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"ordersCount\": 10,\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"c291a53d-0107-4ea7-a4db-82639bd6f78d","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplates($filters: CartTemplateFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: CartTemplateSortByField) {\n cartTemplates(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## cartTemplates\n\n**Propósito:** Lista os templates de carrinho da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para escolher qual template usar em `createCartByTemplate` sem precisar guardar o `_id` de cada um — filtre por status, período ou texto livre. Para buscar um único template já conhecido, use `cartTemplate`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------- | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `CartTemplateFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `CartTemplateSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`CartTemplateFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ---------------- | ---------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[CartTemplateStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n\nDiferente de `paymentLinks`, este filtro **não** tem `fulfillmentTypes`.\n\n### Retorno\n\n`CartTemplateConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | -------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[CartTemplate]` | Lista de templates — mesma forma retornada por `cartTemplate`. |\n| `edges` | `[CartTemplateEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de templates que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **`totalAmount` de cada item é recalculado do preço atual do catálogo**, não congelado no momento da criação do template (diferente de `paymentLinks`). Ver a página do folder **Carrinhos** para o detalhe completo dessa diferença.\n- Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente de `items[]` em cada template retornado.\n- Sem `first`/`last`, o tamanho de página padrão é 20."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"da85ae24-79ff-462c-89c2-07bc3dcf8368","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CartTemplates($filters: CartTemplateFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: CartTemplateSortByField) {\n cartTemplates(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## cartTemplates\n\n**Propósito:** Lista os templates de carrinho da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para escolher qual template usar em `createCartByTemplate` sem precisar guardar o `_id` de cada um — filtre por status, período ou texto livre. Para buscar um único template já conhecido, use `cartTemplate`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------- | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `CartTemplateFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `CartTemplateSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`CartTemplateFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ---------------- | ---------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[CartTemplateStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n\nDiferente de `paymentLinks`, este filtro **não** tem `fulfillmentTypes`.\n\n### Retorno\n\n`CartTemplateConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | -------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[CartTemplate]` | Lista de templates — mesma forma retornada por `cartTemplate`. |\n| `edges` | `[CartTemplateEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de templates que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **`totalAmount` de cada item é recalculado do preço atual do catálogo**, não congelado no momento da criação do template (diferente de `paymentLinks`). Ver a página do folder **Carrinhos** para o detalhe completo dessa diferença.\n- Itens cujo produto/variante não existe mais no catálogo são omitidos silenciosamente de `items[]` em cada template retornado.\n- Sem `first`/`last`, o tamanho de página padrão é 20."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"e4e421df-f343-54b7-8f80-2ba9eae3fc8e"},{"name":"[Query] paymentLink","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns paymentLink data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"paymentLink\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"paymentLink returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.paymentLink;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"referenceId\");"," if (data.referenceId !== undefined && data.referenceId !== null) {"," pm.expect(typeof data.referenceId).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"type\");"," if (data.type !== undefined && data.type !== null) {"," pm.expect(typeof data.type).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"shopId\");"," if (data.shopId !== undefined && data.shopId !== null) {"," pm.expect(typeof data.shopId).to.equal(\"string\");"," }"," if (data.externalId !== undefined && data.externalId !== null) {"," pm.expect(typeof data.externalId).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.updatedAt !== undefined && data.updatedAt !== null) {"," pm.expect(typeof data.updatedAt).to.equal(\"string\");"," }"," if (data.updatedAt) {"," pm.expect(new Date(data.updatedAt).toString()).to.not.equal(\"Invalid Date\");"," }"," pm.expect(data).to.have.property(\"title\");"," if (data.title !== undefined && data.title !== null) {"," pm.expect(typeof data.title).to.equal(\"string\");"," }"," if (data.createdBy !== undefined && data.createdBy !== null) {"," pm.expect(typeof data.createdBy).to.equal(\"string\");"," }"," if (data.updatedBy !== undefined && data.updatedBy !== null) {"," pm.expect(typeof data.updatedBy).to.equal(\"string\");"," }"," }","});"]}}],"id":"bd7b6e54-504a-58cf-9af5-08300fac3afd","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLink($paymentLinkId: ID!) {\n paymentLink(paymentLinkId: $paymentLinkId) {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"paymentLinkId\": \"https://exemplo.com\"\n}"}},"url":"{{base_url}}","description":"paymentLink
\nPropósito: Retorna um único link de pagamento pelo _id.\nQuando usar: Para consultar o status e os detalhes de um link específico que você já criou (por exemplo, o link retornado por createExternalCheckout) — use quando você já tem o _id/referenceId do link. Para buscar por outros critérios (status, período, texto livre), use paymentLinks.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\npaymentLinkId | \nID! | \nSim | \n— | \n_id do link de pagamento a ser buscado. | \n
\n\n
\n
Retorno
\nPaymentLink:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nIdentificador do link. | \n
\n\nreferenceId | \nString! | \nIdentificador legível, único por loja. | \n
\n\nexternalId | \nString | \nO externalId que você enviou ao criar o link (quando aplicável), para correlação com seu sistema. | \n
\n\ntitle / description | \nString! / String | \nTítulo e descrição do link. | \n
\n\nstatus | \nCartTemplateStatus! | \nACTIVE ou PAUSED. | \n
\n\nisSoldOut | \nBoolean! | \ntrue quando constraints.usageLimit está definido e o número de pedidos (ordersCount) já atingiu esse limite. Calculado a cada consulta. | \n
\n\nisExpired | \nBoolean! | \ntrue quando a data atual passou de constraints.expirationDate. Calculado a cada consulta. | \n
\n\ntotalAmount | \nMoney! | \nSoma dos subtotal (price × quantity) dos items, gravada no momento da criação do link — não é recalculada pelo catálogo. | \n
\n\nitems | \n[PaymentLinkItem!]! | \nItens do link. Cada item traz title, description, quantity, price, subtotal, images, parcel, productERPCode, variantERPCode. | \n
\n\nconstraints | \nPaymentLinkConstraints | \nbuyerTypes, usageLimit, expirationDate configurados na criação do link. | \n
\n\nshipping | \nCartTemplateShipping | \nfulfillmentType, fulfillmentOptions, shippingValue configurados no link, se houver frete. | \n
\n\nmetadata | \nPaymentLinkMetadata | \nDados adicionais: orderTotal, orderSummary, successCallbackURL, customerData, discount, shopSales, installmentAmount, orderTotalBeforeInterest, interest. | \n
\n\nordersCount | \nInt | \nQuantidade de pedidos já concluídos a partir deste link. | \n
\n\npaymentMethod | \nPaymentMethodName | \nForma de pagamento vinculada ao link, se aplicável. | \n
\n\nblockPaymentMethodChange | \nBoolean | \nSe true, o comprador não pode trocar a forma de pagamento na página de checkout. | \n
\n\nblockApplyDiscountCode | \nBoolean | \nSe true, códigos de desconto não podem ser aplicados na página de checkout. | \n
\n\nblockApplyShopSale | \nBoolean | \nSe true, promoções da loja não são aplicadas automaticamente na página de checkout. | \n
\n\ncreatedAt / updatedAt | \nAWSDateTime! / AWSDateTime | \nDatas de criação/atualização. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nPAYMENT_LINK_NOT_FOUND_ERROR | \nNão existe link de pagamento não-excluído com o paymentLinkId informado na sua loja. | \nConfira se o _id está correto e se o link pertence à loja autenticada. | \n
\n\n| (sem código) | \nAutenticação/permissão ausente ou inválida: a mensagem começa com \"Unauthorized\". | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Não retorna
null quando não encontrado — lança erro. Apesar do tipo de retorno (PaymentLink, sem !) sugerir que a query poderia devolver null para um ID inexistente, o comportamento real é lançar PAYMENT_LINK_NOT_FOUND_ERROR. Trate essa consulta assumindo que \"não encontrado\" chega como item em errors[], não como data.paymentLink: null. \ntotalAmount é uma soma congelada dos itens do link, diferente de cartTemplate, onde o mesmo campo é recalculado a partir do preço atual do catálogo — não espere que totalAmount mude aqui se o preço do produto mudar depois.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"419d2512-d822-46e1-b1c5-41ff2ccee973","name":"200 - paymentLink","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLink($paymentLinkId: ID!) {\n paymentLink(paymentLinkId: $paymentLinkId) {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"paymentLinkId\": \"https://exemplo.com\"\n}"}},"url":"{{base_url}}","description":"## paymentLink\n\n**Propósito:** Retorna um único link de pagamento pelo `_id`.\n**Quando usar:** Para consultar o status e os detalhes de um link específico que você já criou (por exemplo, o link retornado por `createExternalCheckout`) — use quando você já tem o `_id`/`referenceId` do link. Para buscar por outros critérios (status, período, texto livre), use `paymentLinks`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------- | ---- | ----------- | ------- | ----------------------------------------- |\n| `paymentLinkId` | ID! | Sim | — | `_id` do link de pagamento a ser buscado. |\n\n### Retorno\n\n`PaymentLink`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do link. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `externalId` | `String` | O `externalId` que você enviou ao criar o link (quando aplicável), para correlação com seu sistema. |\n| `title` / `description` | `String!` / `String` | Título e descrição do link. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e o número de pedidos (`ordersCount`) já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma dos `subtotal` (`price × quantity`) dos `items`, **gravada no momento da criação do link** — não é recalculada pelo catálogo. |\n| `items` | `[PaymentLinkItem!]!` | Itens do link. Cada item traz `title`, `description`, `quantity`, `price`, `subtotal`, `images`, `parcel`, `productERPCode`, `variantERPCode`. |\n| `constraints` | `PaymentLinkConstraints` | `buyerTypes`, `usageLimit`, `expirationDate` configurados na criação do link. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no link, se houver frete. |\n| `metadata` | `PaymentLinkMetadata` | Dados adicionais: `orderTotal`, `orderSummary`, `successCallbackURL`, `customerData`, `discount`, `shopSales`, `installmentAmount`, `orderTotalBeforeInterest`, `interest`. |\n| `ordersCount` | `Int` | Quantidade de pedidos já concluídos a partir deste link. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao link, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o comprador não pode trocar a forma de pagamento na página de checkout. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados na página de checkout. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente na página de checkout. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| `PAYMENT_LINK_NOT_FOUND_ERROR` | Não existe link de pagamento não-excluído com o `paymentLinkId` informado na sua loja. | Confira se o `_id` está correto e se o link pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`PaymentLink`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `PAYMENT_LINK_NOT_FOUND_ERROR`. Trate essa consulta assumindo que \"não encontrado\" chega como item em `errors[]`, não como `data.paymentLink: null`.\n- **`totalAmount` é uma soma congelada dos itens do link**, diferente de `cartTemplate`, onde o mesmo campo é recalculado a partir do preço atual do catálogo — não espere que `totalAmount` mude aqui se o preço do produto mudar depois."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"paymentLink\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"totalAmount\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"constraints\": {\n \"buyerTypes\": [\n \"COMPANY\"\n ],\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\"\n },\n \"description\": \"Example_String\",\n \"items\": [\n {\n \"_id\": \"Example_String\",\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"quantity\": 1,\n \"productERPCode\": \"Example_String\",\n \"variantERPCode\": \"Example_String\"\n }\n ],\n \"ordersCount\": 10,\n \"metadata\": {\n \"successCallbackURL\": \"https://exemplo.com\"\n },\n \"paymentMethod\": {},\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n}"},{"id":"46509df0-b934-4056-8870-dba445f0682d","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLink($paymentLinkId: ID!) {\n paymentLink(paymentLinkId: $paymentLinkId) {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"paymentLinkId\": \"https://exemplo.com\"\n}"}},"url":"{{base_url}}","description":"## paymentLink\n\n**Propósito:** Retorna um único link de pagamento pelo `_id`.\n**Quando usar:** Para consultar o status e os detalhes de um link específico que você já criou (por exemplo, o link retornado por `createExternalCheckout`) — use quando você já tem o `_id`/`referenceId` do link. Para buscar por outros critérios (status, período, texto livre), use `paymentLinks`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------- | ---- | ----------- | ------- | ----------------------------------------- |\n| `paymentLinkId` | ID! | Sim | — | `_id` do link de pagamento a ser buscado. |\n\n### Retorno\n\n`PaymentLink`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do link. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `externalId` | `String` | O `externalId` que você enviou ao criar o link (quando aplicável), para correlação com seu sistema. |\n| `title` / `description` | `String!` / `String` | Título e descrição do link. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e o número de pedidos (`ordersCount`) já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma dos `subtotal` (`price × quantity`) dos `items`, **gravada no momento da criação do link** — não é recalculada pelo catálogo. |\n| `items` | `[PaymentLinkItem!]!` | Itens do link. Cada item traz `title`, `description`, `quantity`, `price`, `subtotal`, `images`, `parcel`, `productERPCode`, `variantERPCode`. |\n| `constraints` | `PaymentLinkConstraints` | `buyerTypes`, `usageLimit`, `expirationDate` configurados na criação do link. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no link, se houver frete. |\n| `metadata` | `PaymentLinkMetadata` | Dados adicionais: `orderTotal`, `orderSummary`, `successCallbackURL`, `customerData`, `discount`, `shopSales`, `installmentAmount`, `orderTotalBeforeInterest`, `interest`. |\n| `ordersCount` | `Int` | Quantidade de pedidos já concluídos a partir deste link. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao link, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o comprador não pode trocar a forma de pagamento na página de checkout. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados na página de checkout. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente na página de checkout. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| `PAYMENT_LINK_NOT_FOUND_ERROR` | Não existe link de pagamento não-excluído com o `paymentLinkId` informado na sua loja. | Confira se o `_id` está correto e se o link pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`PaymentLink`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `PAYMENT_LINK_NOT_FOUND_ERROR`. Trate essa consulta assumindo que \"não encontrado\" chega como item em `errors[]`, não como `data.paymentLink: null`.\n- **`totalAmount` é uma soma congelada dos itens do link**, diferente de `cartTemplate`, onde o mesmo campo é recalculado a partir do preço atual do catálogo — não espere que `totalAmount` mude aqui se o preço do produto mudar depois."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"b1bf244f-6a4c-4977-a9c0-afbcaa4526a3","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLink($paymentLinkId: ID!) {\n paymentLink(paymentLinkId: $paymentLinkId) {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"paymentLinkId\": \"https://exemplo.com\"\n}"}},"url":"{{base_url}}","description":"## paymentLink\n\n**Propósito:** Retorna um único link de pagamento pelo `_id`.\n**Quando usar:** Para consultar o status e os detalhes de um link específico que você já criou (por exemplo, o link retornado por `createExternalCheckout`) — use quando você já tem o `_id`/`referenceId` do link. Para buscar por outros critérios (status, período, texto livre), use `paymentLinks`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------- | ---- | ----------- | ------- | ----------------------------------------- |\n| `paymentLinkId` | ID! | Sim | — | `_id` do link de pagamento a ser buscado. |\n\n### Retorno\n\n`PaymentLink`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do link. |\n| `referenceId` | `String!` | Identificador legível, único por loja. |\n| `externalId` | `String` | O `externalId` que você enviou ao criar o link (quando aplicável), para correlação com seu sistema. |\n| `title` / `description` | `String!` / `String` | Título e descrição do link. |\n| `status` | `CartTemplateStatus!` | `ACTIVE` ou `PAUSED`. |\n| `isSoldOut` | `Boolean!` | `true` quando `constraints.usageLimit` está definido e o número de pedidos (`ordersCount`) já atingiu esse limite. Calculado a cada consulta. |\n| `isExpired` | `Boolean!` | `true` quando a data atual passou de `constraints.expirationDate`. Calculado a cada consulta. |\n| `totalAmount` | `Money!` | Soma dos `subtotal` (`price × quantity`) dos `items`, **gravada no momento da criação do link** — não é recalculada pelo catálogo. |\n| `items` | `[PaymentLinkItem!]!` | Itens do link. Cada item traz `title`, `description`, `quantity`, `price`, `subtotal`, `images`, `parcel`, `productERPCode`, `variantERPCode`. |\n| `constraints` | `PaymentLinkConstraints` | `buyerTypes`, `usageLimit`, `expirationDate` configurados na criação do link. |\n| `shipping` | `CartTemplateShipping` | `fulfillmentType`, `fulfillmentOptions`, `shippingValue` configurados no link, se houver frete. |\n| `metadata` | `PaymentLinkMetadata` | Dados adicionais: `orderTotal`, `orderSummary`, `successCallbackURL`, `customerData`, `discount`, `shopSales`, `installmentAmount`, `orderTotalBeforeInterest`, `interest`. |\n| `ordersCount` | `Int` | Quantidade de pedidos já concluídos a partir deste link. |\n| `paymentMethod` | `PaymentMethodName` | Forma de pagamento vinculada ao link, se aplicável. |\n| `blockPaymentMethodChange` | `Boolean` | Se `true`, o comprador não pode trocar a forma de pagamento na página de checkout. |\n| `blockApplyDiscountCode` | `Boolean` | Se `true`, códigos de desconto não podem ser aplicados na página de checkout. |\n| `blockApplyShopSale` | `Boolean` | Se `true`, promoções da loja não são aplicadas automaticamente na página de checkout. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| `PAYMENT_LINK_NOT_FOUND_ERROR` | Não existe link de pagamento não-excluído com o `paymentLinkId` informado na sua loja. | Confira se o `_id` está correto e se o link pertence à loja autenticada. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Não retorna `null` quando não encontrado — lança erro.** Apesar do tipo de retorno (`PaymentLink`, sem `!`) sugerir que a query poderia devolver `null` para um ID inexistente, o comportamento real é lançar `PAYMENT_LINK_NOT_FOUND_ERROR`. Trate essa consulta assumindo que \"não encontrado\" chega como item em `errors[]`, não como `data.paymentLink: null`.\n- **`totalAmount` é uma soma congelada dos itens do link**, diferente de `cartTemplate`, onde o mesmo campo é recalculado a partir do preço atual do catálogo — não espere que `totalAmount` mude aqui se o preço do produto mudar depois."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"bd7b6e54-504a-58cf-9af5-08300fac3afd"},{"name":"[Query] paymentLinks","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns paymentLinks data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"paymentLinks\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"paymentLinks returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.paymentLinks;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"e552f8bc-6b77-54a1-aa51-b1da1c791dbe","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLinks($filters: PaymentLinkFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: PaymentLinkSortByField) {\n paymentLinks(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"paymentLinks
\nPropósito: Lista os links de pagamento da sua loja, com filtros e paginação Relay.\nQuando usar: Para acompanhar links de pagamento criados (por exemplo, via createExternalCheckout) sem precisar guardar o _id de cada um — filtre por status, período de criação/expiração ou texto livre. Para buscar um único link já conhecido, use paymentLink.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nPaymentLinkFilterInput | \nNão | \n— | \nVer tabela de filtros abaixo. | \n
\n\nafter / before | \nString | \nNão | \n— | \nCursor Relay para paginação para frente/para trás. | \n
\n\nfirst / last | \nInt (1–50) | \nNão | \n20 (se nenhum for enviado) | \nTamanho da página. Envie apenas um dos dois — first com after, ou last com before. | \n
\n\noffset | \nInt | \nNão | \n— | \nPula os N primeiros resultados. Pode ser combinado com first. | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nasc ou desc. | \n
\n\nsortBy | \nPaymentLinkSortByField | \nNão | \nCREATED_AT | \nTITLE, CREATED_AT, EXPIRATION_DATE, STATUS. | \n
\n\n
\n
\n\n\n| Nome | \nTipo | \nDescrição | \n
\n\n\n\ntitle | \nString | \nFiltro por título, contendo o texto (case-insensitive). | \n
\n\ntextQuery | \nString | \nBusca livre que casa contra title ou referenceId (case-insensitive). | \n
\n\nstatus | \n[PaymentLinkStatus] | \nRestringe a uma ou mais das opções ACTIVE, PAUSED. | \n
\n\nisSoldOut | \nBoolean | \nFiltra pelo valor calculado de isSoldOut (ver folder para como é calculado). | \n
\n\nisExpired | \nBoolean | \nFiltra pelo valor calculado de isExpired. | \n
\n\ncreatedAt | \nDateFilterInput | \n{ gte, lte } em AWSDateTime, ambos opcionais. | \n
\n\nexpirationDate | \nDateFilterInput | \nMesma forma de createdAt, aplicada à data de expiração configurada em constraints.expirationDate. | \n
\n\nfulfillmentTypes | \n[FulfillmentType] | \nRestringe pelo tipo de frete configurado (SHIPPING, NONE). | \n
\n\n
\n
Retorno
\nPaymentLinkConnection!:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes | \n[PaymentLink] | \nLista de links de pagamento — mesma forma retornada por paymentLink. | \n
\n\nedges | \n[PaymentLinkEdge] | \n{ cursor, node }, para clientes que paginam via cursor por edge em vez de nodes diretamente. | \n
\n\npageInfo | \nPageInfo! | \nhasNextPage, hasPreviousPage, startCursor, endCursor. | \n
\n\ntotalCount | \nInt! | \nTotal de links que casam com os filtros, ignorando paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nfirst e last enviados juntos. | \nEnvie apenas um dos dois. | \n
\n\n| (sem código) | \nfirst/last fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | \nCorrija o valor conforme a tabela de argumentos; verifique message do erro. | \n
\n\n| (sem código) | \nAutenticação/permissão ausente ou inválida: a mensagem começa com \"Unauthorized\". | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Erros de validação de argumentos não carregam um extensions.code estável — confira sempre message.
\n
\nNotas
\n\n- Sem filtro de
externalId. Se você precisa localizar o link criado para um pedido específico do seu sistema, use textQuery/title ou guarde o _id/referenceId retornado na criação — o filtro não expõe externalId. \ntotalAmount de cada item é a soma congelada dos subtotais gravados na criação do link, não um valor recalculado do catálogo (diferente de cartTemplates).- Sem
first/last, o tamanho de página padrão é 20 (ver a página do folder Carrinhos para os detalhes de paginação Relay compartilhados com cartTemplates). \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"161f4563-02e8-4af1-9a9e-b7a5c95a4a84","name":"200 - paymentLinks","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLinks($filters: PaymentLinkFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: PaymentLinkSortByField) {\n paymentLinks(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## paymentLinks\n\n**Propósito:** Lista os links de pagamento da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para acompanhar links de pagamento criados (por exemplo, via `createExternalCheckout`) sem precisar guardar o `_id` de cada um — filtre por status, período de criação/expiração ou texto livre. Para buscar um único link já conhecido, use `paymentLink`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------ | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `PaymentLinkFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `PaymentLinkSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`PaymentLinkFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------ | --------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[PaymentLinkStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n| `fulfillmentTypes` | `[FulfillmentType]` | Restringe pelo tipo de frete configurado (`SHIPPING`, `NONE`). |\n\n### Retorno\n\n`PaymentLinkConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | ------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[PaymentLink]` | Lista de links de pagamento — mesma forma retornada por `paymentLink`. |\n| `edges` | `[PaymentLinkEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de links que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **Sem filtro de `externalId`.** Se você precisa localizar o link criado para um pedido específico do seu sistema, use `textQuery`/`title` ou guarde o `_id`/`referenceId` retornado na criação — o filtro não expõe `externalId`.\n- **`totalAmount` de cada item é a soma congelada dos subtotais gravados na criação do link**, não um valor recalculado do catálogo (diferente de `cartTemplates`).\n- Sem `first`/`last`, o tamanho de página padrão é 20 (ver a página do folder **Carrinhos** para os detalhes de paginação Relay compartilhados com `cartTemplates`)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"paymentLinks\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"description\": \"Example_String\",\n \"ordersCount\": 10,\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"6d2b216c-5e61-4301-92a6-3ee73bcf8166","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLinks($filters: PaymentLinkFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: PaymentLinkSortByField) {\n paymentLinks(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## paymentLinks\n\n**Propósito:** Lista os links de pagamento da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para acompanhar links de pagamento criados (por exemplo, via `createExternalCheckout`) sem precisar guardar o `_id` de cada um — filtre por status, período de criação/expiração ou texto livre. Para buscar um único link já conhecido, use `paymentLink`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------ | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `PaymentLinkFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `PaymentLinkSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`PaymentLinkFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------ | --------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[PaymentLinkStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n| `fulfillmentTypes` | `[FulfillmentType]` | Restringe pelo tipo de frete configurado (`SHIPPING`, `NONE`). |\n\n### Retorno\n\n`PaymentLinkConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | ------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[PaymentLink]` | Lista de links de pagamento — mesma forma retornada por `paymentLink`. |\n| `edges` | `[PaymentLinkEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de links que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **Sem filtro de `externalId`.** Se você precisa localizar o link criado para um pedido específico do seu sistema, use `textQuery`/`title` ou guarde o `_id`/`referenceId` retornado na criação — o filtro não expõe `externalId`.\n- **`totalAmount` de cada item é a soma congelada dos subtotais gravados na criação do link**, não um valor recalculado do catálogo (diferente de `cartTemplates`).\n- Sem `first`/`last`, o tamanho de página padrão é 20 (ver a página do folder **Carrinhos** para os detalhes de paginação Relay compartilhados com `cartTemplates`)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"21e774d0-e105-4992-917c-5531ca53b88c","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query PaymentLinks($filters: PaymentLinkFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: PaymentLinkSortByField) {\n paymentLinks(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n nodes {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"title\": \"Example_String\",\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": [\n \"ACTIVE\"\n ],\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"expirationDate\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"textQuery\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"TITLE\"\n}"}},"url":"{{base_url}}","description":"## paymentLinks\n\n**Propósito:** Lista os links de pagamento da sua loja, com filtros e paginação Relay.\n**Quando usar:** Para acompanhar links de pagamento criados (por exemplo, via `createExternalCheckout`) sem precisar guardar o `_id` de cada um — filtre por status, período de criação/expiração ou texto livre. Para buscar um único link já conhecido, use `paymentLink`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------ | ------------------------ | ----------- | -------------------------- | ---------------------------------------------------------------------------------------------- |\n| `filters` | `PaymentLinkFilterInput` | Não | — | Ver tabela de filtros abaixo. |\n| `after` / `before` | `String` | Não | — | Cursor Relay para paginação para frente/para trás. |\n| `first` / `last` | `Int` (1–50) | Não | 20 (se nenhum for enviado) | Tamanho da página. Envie **apenas um** dos dois — `first` com `after`, ou `last` com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | `asc` ou `desc`. |\n| `sortBy` | `PaymentLinkSortByField` | Não | `CREATED_AT` | `TITLE`, `CREATED_AT`, `EXPIRATION_DATE`, `STATUS`. |\n\n#### Campos de `filters` (`PaymentLinkFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------ | --------------------- | ----------------------------------------------------------------------------------------------------- |\n| `title` | `String` | Filtro por título, contendo o texto (case-insensitive). |\n| `textQuery` | `String` | Busca livre que casa contra `title` **ou** `referenceId` (case-insensitive). |\n| `status` | `[PaymentLinkStatus]` | Restringe a uma ou mais das opções `ACTIVE`, `PAUSED`. |\n| `isSoldOut` | `Boolean` | Filtra pelo valor calculado de `isSoldOut` (ver folder para como é calculado). |\n| `isExpired` | `Boolean` | Filtra pelo valor calculado de `isExpired`. |\n| `createdAt` | `DateFilterInput` | `{ gte, lte }` em `AWSDateTime`, ambos opcionais. |\n| `expirationDate` | `DateFilterInput` | Mesma forma de `createdAt`, aplicada à data de expiração configurada em `constraints.expirationDate`. |\n| `fulfillmentTypes` | `[FulfillmentType]` | Restringe pelo tipo de frete configurado (`SHIPPING`, `NONE`). |\n\n### Retorno\n\n`PaymentLinkConnection!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | ------------------- | ------------------------------------------------------------------------------------------------ |\n| `nodes` | `[PaymentLink]` | Lista de links de pagamento — mesma forma retornada por `paymentLink`. |\n| `edges` | `[PaymentLinkEdge]` | `{ cursor, node }`, para clientes que paginam via cursor por edge em vez de `nodes` diretamente. |\n| `pageInfo` | `PageInfo!` | `hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`. |\n| `totalCount` | `Int!` | Total de links que casam com os filtros, ignorando paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |\n| _(sem código)_ | `first` e `last` enviados juntos. | Envie apenas um dos dois. |\n| _(sem código)_ | `first`/`last` fora do intervalo de 1 a 50, ou outro campo de filtro fora do formato esperado. | Corrija o valor conforme a tabela de argumentos; verifique `message` do erro. |\n| _(sem código)_ | Autenticação/permissão ausente ou inválida: a mensagem começa com `\"Unauthorized\"`. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação de argumentos não carregam um `extensions.code` estável — confira sempre `message`.\n\n### Notas\n\n- **Sem filtro de `externalId`.** Se você precisa localizar o link criado para um pedido específico do seu sistema, use `textQuery`/`title` ou guarde o `_id`/`referenceId` retornado na criação — o filtro não expõe `externalId`.\n- **`totalAmount` de cada item é a soma congelada dos subtotais gravados na criação do link**, não um valor recalculado do catálogo (diferente de `cartTemplates`).\n- Sem `first`/`last`, o tamanho de página padrão é 20 (ver a página do folder **Carrinhos** para os detalhes de paginação Relay compartilhados com `cartTemplates`)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"e552f8bc-6b77-54a1-aa51-b1da1c791dbe"}],"id":"e017b0a8-abcd-46fb-91c2-95304100e916","_postman_id":"e017b0a8-abcd-46fb-91c2-95304100e916","description":""},{"name":"Mutation","item":[{"name":"[Mutation] createCartByTemplate","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns createCartByTemplate data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"createCartByTemplate\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"7cf9ebd7-4d3a-5a08-95a1-26935202df15","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartByTemplate($input: CreateCartByTemplateInput!) {\n createCartByTemplate(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n clientMutationId\n incorrectPriceFailures {\n currentPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n providedPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n minOrderQuantityFailures {\n minOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n maxOrderQuantityFailures {\n maxOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n token\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"shopId\": \"{{shopId}}\",\n \"cartTemplateId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"createCartByTemplate
\nPropósito: Cria um carrinho novo a partir de um template de carrinho existente, copiando seus itens, frete e desconto configurados.\nQuando usar: Depois de escolher um template (via cartTemplate/cartTemplates) que represente a compra desejada. O carrinho criado é anônimo (não fica vinculado à sua conta) — guarde o token retornado, pois ele é a única forma de referenciar esse carrinho depois em updateCart. Não é idempotente: cada chamada bem-sucedida cria um carrinho novo, mesmo enviando o mesmo cartTemplateId — chamar duas vezes gera dois carrinhos distintos. Se sua chamada falhar por timeout de rede antes de você ler a resposta, um carrinho pode ter sido criado mesmo assim; reenviar cegamente pode duplicar. A API não expõe uma forma de listar carrinhos por cartTemplateId, então o controle de reenvio precisa ficar do seu lado.\nAutenticação: x-api-key + Authorization. Mesmo esta operação não exigindo permissão específica internamente, envie sempre um Authorization válido — sem ele o carrinho é criado sem vínculo de conta.
\nArgumentos
\nÚnico argumento: input: CreateCartByTemplateInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.shopId | \nID! | \nSim | \n— | \nID da sua loja. Diferente de outras operações desta API, aqui o shopId não é derivado do token — envie-o explicitamente. | \n
\n\ninput.cartTemplateId | \nID! | \nSim | \n— | \n_id do template de carrinho a ser usado (ver cartTemplate/cartTemplates). | \n
\n\n
\n
Retorno
\nCreateCartPayload!:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ncart | \nCart | \nO carrinho recém-criado. null se nenhum item do template pôde ser adicionado (ver minOrderQuantityFailures/maxOrderQuantityFailures). | \n
\n\ntoken | \nString | \nToken de acesso ao carrinho anônimo recém-criado. É retornado apenas nesta chamada — armazene-o com segurança, você precisará dele em updateCart (cartToken). | \n
\n\nincorrectPriceFailures | \n[IncorrectPriceFailureDetails]! | \nSempre vazio nesta operação: o preço é herdado do template, e a checagem de preço enviado pelo parceiro não se aplica aqui. | \n
\n\nminOrderQuantityFailures | \n[MinOrderQuantityFailureDetails]! | \nItens do template cuja quantidade configurada ficou abaixo do mínimo atual de pedido do produto/variante. | \n
\n\nmaxOrderQuantityFailures | \n[MaxOrderQuantityFailureDetails]! | \nItens do template cuja quantidade configurada ficou acima do máximo atual de pedido do produto/variante. | \n
\n\ncartEvents | \n[CartEvent] | \nEventos relevantes ocorridos como efeito colateral (ex.: desconto do template removido por não ser mais válido). | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nCART_TEMPLATE_NOT_FOUND_ERROR | \nNão existe template não-excluído com o cartTemplateId informado, na loja informada por shopId. | \nConfira cartTemplateId e shopId; use cartTemplate/cartTemplates para localizar o template correto. | \n
\n\nCART_TEMPLATE_PAUSED_ERROR | \nO template está com status: PAUSED. | \nReative o template (updateCartTemplate) antes de usá-lo, ou escolha outro. | \n
\n\nCART_TEMPLATE_IS_EXPIRED_ERROR | \nA data atual passou de constraints.expirationDate do template. | \nEscolha um template não expirado, ou peça para configurarem uma nova data de expiração. | \n
\n\nCART_TEMPLATE_IS_SOLD_OUT_ERROR | \nconstraints.usageLimit do template já foi atingido pelo número de carrinhos/pedidos gerados. | \nEscolha outro template, ou peça para aumentarem/removerem o limite. | \n
\n\nALL_ITEMS_OUT_OF_STOCK_ERROR | \nNenhum item do template tem estoque disponível no momento. | \nVerifique o estoque dos produtos do template (simpleInventory) antes de tentar novamente. | \n
\n\nUNABLE_TO_SAVE_CART_ERROR | \nFalha ao persistir o carrinho (erro interno). | \nTente novamente; se persistir, contate seu representante Unbox. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Campos obrigatórios ausentes (shopId, cartTemplateId) retornam um erro de validação com mensagem descritiva, sem extensions.code estável — verifique sempre message.
\n
\nNotas
\n\n- Não é idempotente. Repetir a chamada com o mesmo
cartTemplateId cria um novo carrinho a cada vez (não há deduplicação por template ou por qualquer outro campo do input). \n- O carrinho criado é anônimo. Ele não fica automaticamente vinculado à sua conta autenticada — o acesso a ele depois é feito pelo par
cartId/cartToken retornado nesta chamada, não pelo Authorization. \ntoken só é retornado nesta chamada. Se você perdê-lo, não há como recuperá-lo depois — trate-o como o cartToken necessário para toda operação futura sobre esse carrinho.- Descontos configurados no template (
discount.code) são reaplicados automaticamente ao carrinho recém-criado, se ainda válidos. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"665dc3dd-d8bf-4fa6-a1f9-64ff31b13605","name":"200 - createCartByTemplate","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartByTemplate($input: CreateCartByTemplateInput!) {\n createCartByTemplate(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n clientMutationId\n incorrectPriceFailures {\n currentPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n providedPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n minOrderQuantityFailures {\n minOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n maxOrderQuantityFailures {\n maxOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n token\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"shopId\": \"{{shopId}}\",\n \"cartTemplateId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## createCartByTemplate\n\n**Propósito:** Cria um carrinho novo a partir de um template de carrinho existente, copiando seus itens, frete e desconto configurados.\n**Quando usar:** Depois de escolher um template (via `cartTemplate`/`cartTemplates`) que represente a compra desejada. O carrinho criado é anônimo (não fica vinculado à sua conta) — guarde o `token` retornado, pois ele é a única forma de referenciar esse carrinho depois em `updateCart`. **Não é idempotente**: cada chamada bem-sucedida cria um carrinho novo, mesmo enviando o mesmo `cartTemplateId` — chamar duas vezes gera dois carrinhos distintos. Se sua chamada falhar por timeout de rede antes de você ler a resposta, um carrinho pode ter sido criado mesmo assim; reenviar cegamente pode duplicar. A API não expõe uma forma de listar carrinhos por `cartTemplateId`, então o controle de reenvio precisa ficar do seu lado.\n**Autenticação:** `x-api-key` + `Authorization`. Mesmo esta operação não exigindo permissão específica internamente, envie sempre um `Authorization` válido — sem ele o carrinho é criado sem vínculo de conta.\n\n### Argumentos\n\nÚnico argumento: `input: CreateCartByTemplateInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------------- | ----- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `input.shopId` | `ID!` | Sim | — | ID da sua loja. Diferente de outras operações desta API, aqui o `shopId` **não** é derivado do token — envie-o explicitamente. |\n| `input.cartTemplateId` | `ID!` | Sim | — | `_id` do template de carrinho a ser usado (ver `cartTemplate`/`cartTemplates`). |\n\n### Retorno\n\n`CreateCartPayload!`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cart` | `Cart` | O carrinho recém-criado. `null` se nenhum item do template pôde ser adicionado (ver `minOrderQuantityFailures`/`maxOrderQuantityFailures`). |\n| `token` | `String` | Token de acesso ao carrinho anônimo recém-criado. **É retornado apenas nesta chamada** — armazene-o com segurança, você precisará dele em `updateCart` (`cartToken`). |\n| `incorrectPriceFailures` | `[IncorrectPriceFailureDetails]!` | Sempre vazio nesta operação: o preço é herdado do template, e a checagem de preço enviado pelo parceiro não se aplica aqui. |\n| `minOrderQuantityFailures` | `[MinOrderQuantityFailureDetails]!` | Itens do template cuja quantidade configurada ficou abaixo do mínimo atual de pedido do produto/variante. |\n| `maxOrderQuantityFailures` | `[MaxOrderQuantityFailureDetails]!` | Itens do template cuja quantidade configurada ficou acima do máximo atual de pedido do produto/variante. |\n| `cartEvents` | `[CartEvent]` | Eventos relevantes ocorridos como efeito colateral (ex.: desconto do template removido por não ser mais válido). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| `CART_TEMPLATE_NOT_FOUND_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado, na loja informada por `shopId`. | Confira `cartTemplateId` e `shopId`; use `cartTemplate`/`cartTemplates` para localizar o template correto. |\n| `CART_TEMPLATE_PAUSED_ERROR` | O template está com `status: PAUSED`. | Reative o template (`updateCartTemplate`) antes de usá-lo, ou escolha outro. |\n| `CART_TEMPLATE_IS_EXPIRED_ERROR` | A data atual passou de `constraints.expirationDate` do template. | Escolha um template não expirado, ou peça para configurarem uma nova data de expiração. |\n| `CART_TEMPLATE_IS_SOLD_OUT_ERROR` | `constraints.usageLimit` do template já foi atingido pelo número de carrinhos/pedidos gerados. | Escolha outro template, ou peça para aumentarem/removerem o limite. |\n| `ALL_ITEMS_OUT_OF_STOCK_ERROR` | Nenhum item do template tem estoque disponível no momento. | Verifique o estoque dos produtos do template (`simpleInventory`) antes de tentar novamente. |\n| `UNABLE_TO_SAVE_CART_ERROR` | Falha ao persistir o carrinho (erro interno). | Tente novamente; se persistir, contate seu representante Unbox. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Campos obrigatórios ausentes (`shopId`, `cartTemplateId`) retornam um erro de validação com mensagem descritiva, sem `extensions.code` estável — verifique sempre `message`.\n\n### Notas\n\n- **Não é idempotente.** Repetir a chamada com o mesmo `cartTemplateId` cria um novo carrinho a cada vez (não há deduplicação por template ou por qualquer outro campo do input).\n- **O carrinho criado é anônimo.** Ele não fica automaticamente vinculado à sua conta autenticada — o acesso a ele depois é feito pelo par `cartId`/`cartToken` retornado nesta chamada, não pelo `Authorization`.\n- **`token` só é retornado nesta chamada.** Se você perdê-lo, não há como recuperá-lo depois — trate-o como o `cartToken` necessário para toda operação futura sobre esse carrinho.\n- Descontos configurados no template (`discount.code`) são reaplicados automaticamente ao carrinho recém-criado, se ainda válidos."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createCartByTemplate\": {\n \"cart\": {\n \"_id\": \"Example_ID\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"email\": \"cliente@exemplo.com\",\n \"expiresAt\": \"2025-01-15T10:00:00Z\",\n \"referenceId\": \"Example_String\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"totalItemQuantity\": 10,\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"blockPaymentMethodChange\": true,\n \"numberOfInstallments\": 10\n },\n \"clientMutationId\": \"Example_String\",\n \"incorrectPriceFailures\": [\n {}\n ],\n \"minOrderQuantityFailures\": [\n {\n \"minOrderQuantity\": 10,\n \"quantity\": 1\n }\n ],\n \"maxOrderQuantityFailures\": [\n {\n \"maxOrderQuantity\": 10,\n \"quantity\": 1\n }\n ],\n \"token\": \"Example_String\",\n \"cartEvents\": [\n {\n \"type\": \"SALE_FREE_ITEM_ADDED\",\n \"data\": {}\n }\n ]\n }\n }\n}"},{"id":"3dc900a1-317e-4f46-9638-2dc10d6ebfdd","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartByTemplate($input: CreateCartByTemplateInput!) {\n createCartByTemplate(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n clientMutationId\n incorrectPriceFailures {\n currentPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n providedPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n minOrderQuantityFailures {\n minOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n maxOrderQuantityFailures {\n maxOrderQuantity\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n }\n token\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"shopId\": \"{{shopId}}\",\n \"cartTemplateId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## createCartByTemplate\n\n**Propósito:** Cria um carrinho novo a partir de um template de carrinho existente, copiando seus itens, frete e desconto configurados.\n**Quando usar:** Depois de escolher um template (via `cartTemplate`/`cartTemplates`) que represente a compra desejada. O carrinho criado é anônimo (não fica vinculado à sua conta) — guarde o `token` retornado, pois ele é a única forma de referenciar esse carrinho depois em `updateCart`. **Não é idempotente**: cada chamada bem-sucedida cria um carrinho novo, mesmo enviando o mesmo `cartTemplateId` — chamar duas vezes gera dois carrinhos distintos. Se sua chamada falhar por timeout de rede antes de você ler a resposta, um carrinho pode ter sido criado mesmo assim; reenviar cegamente pode duplicar. A API não expõe uma forma de listar carrinhos por `cartTemplateId`, então o controle de reenvio precisa ficar do seu lado.\n**Autenticação:** `x-api-key` + `Authorization`. Mesmo esta operação não exigindo permissão específica internamente, envie sempre um `Authorization` válido — sem ele o carrinho é criado sem vínculo de conta.\n\n### Argumentos\n\nÚnico argumento: `input: CreateCartByTemplateInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------------- | ----- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `input.shopId` | `ID!` | Sim | — | ID da sua loja. Diferente de outras operações desta API, aqui o `shopId` **não** é derivado do token — envie-o explicitamente. |\n| `input.cartTemplateId` | `ID!` | Sim | — | `_id` do template de carrinho a ser usado (ver `cartTemplate`/`cartTemplates`). |\n\n### Retorno\n\n`CreateCartPayload!`:\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `cart` | `Cart` | O carrinho recém-criado. `null` se nenhum item do template pôde ser adicionado (ver `minOrderQuantityFailures`/`maxOrderQuantityFailures`). |\n| `token` | `String` | Token de acesso ao carrinho anônimo recém-criado. **É retornado apenas nesta chamada** — armazene-o com segurança, você precisará dele em `updateCart` (`cartToken`). |\n| `incorrectPriceFailures` | `[IncorrectPriceFailureDetails]!` | Sempre vazio nesta operação: o preço é herdado do template, e a checagem de preço enviado pelo parceiro não se aplica aqui. |\n| `minOrderQuantityFailures` | `[MinOrderQuantityFailureDetails]!` | Itens do template cuja quantidade configurada ficou abaixo do mínimo atual de pedido do produto/variante. |\n| `maxOrderQuantityFailures` | `[MaxOrderQuantityFailureDetails]!` | Itens do template cuja quantidade configurada ficou acima do máximo atual de pedido do produto/variante. |\n| `cartEvents` | `[CartEvent]` | Eventos relevantes ocorridos como efeito colateral (ex.: desconto do template removido por não ser mais válido). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |\n| `CART_TEMPLATE_NOT_FOUND_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado, na loja informada por `shopId`. | Confira `cartTemplateId` e `shopId`; use `cartTemplate`/`cartTemplates` para localizar o template correto. |\n| `CART_TEMPLATE_PAUSED_ERROR` | O template está com `status: PAUSED`. | Reative o template (`updateCartTemplate`) antes de usá-lo, ou escolha outro. |\n| `CART_TEMPLATE_IS_EXPIRED_ERROR` | A data atual passou de `constraints.expirationDate` do template. | Escolha um template não expirado, ou peça para configurarem uma nova data de expiração. |\n| `CART_TEMPLATE_IS_SOLD_OUT_ERROR` | `constraints.usageLimit` do template já foi atingido pelo número de carrinhos/pedidos gerados. | Escolha outro template, ou peça para aumentarem/removerem o limite. |\n| `ALL_ITEMS_OUT_OF_STOCK_ERROR` | Nenhum item do template tem estoque disponível no momento. | Verifique o estoque dos produtos do template (`simpleInventory`) antes de tentar novamente. |\n| `UNABLE_TO_SAVE_CART_ERROR` | Falha ao persistir o carrinho (erro interno). | Tente novamente; se persistir, contate seu representante Unbox. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Campos obrigatórios ausentes (`shopId`, `cartTemplateId`) retornam um erro de validação com mensagem descritiva, sem `extensions.code` estável — verifique sempre `message`.\n\n### Notas\n\n- **Não é idempotente.** Repetir a chamada com o mesmo `cartTemplateId` cria um novo carrinho a cada vez (não há deduplicação por template ou por qualquer outro campo do input).\n- **O carrinho criado é anônimo.** Ele não fica automaticamente vinculado à sua conta autenticada — o acesso a ele depois é feito pelo par `cartId`/`cartToken` retornado nesta chamada, não pelo `Authorization`.\n- **`token` só é retornado nesta chamada.** Se você perdê-lo, não há como recuperá-lo depois — trate-o como o `cartToken` necessário para toda operação futura sobre esse carrinho.\n- Descontos configurados no template (`discount.code`) são reaplicados automaticamente ao carrinho recém-criado, se ainda válidos."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"7cf9ebd7-4d3a-5a08-95a1-26935202df15"},{"name":"[Mutation] updateCart","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns updateCart data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"updateCart\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"11dceca8-ef8a-5770-b638-0d30b87c8511","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCart($input: UpdateCartInput!) {\n updateCart(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"cartId\": \"{{cartId}}\",\n \"cartToken\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"numberOfInstallments\": 10\n }\n}"}},"url":"{{base_url}}","description":"updateCart
\nPropósito: Atualiza a forma de pagamento, o número de parcelas e/ou a frequência de recorrência de um carrinho existente.\nQuando usar: Depois de criar um carrinho (por exemplo, com createCartByTemplate), para definir ou trocar como o comprador vai pagar antes de fechar o pedido. É idempotente para o mesmo conjunto de valores: reenviar o mesmo input sobre o mesmo carrinho aplica o mesmo estado novamente sem efeito colateral adicional; porém, como é uma atualização parcial, cada chamada só altera os campos que você enviar — campos omitidos permanecem com o valor atual do carrinho.\nAutenticação: x-api-key + Authorization. Se o carrinho pertencer a uma conta (não for anônimo), você precisa estar autenticado como essa mesma conta — caso contrário a chamada falha com FORBIDDEN_ERROR. Para carrinhos anônimos (por exemplo, criados por createCartByTemplate), a validação é feita pelo cartToken, não pela conta.
\nArgumentos
\nÚnico argumento: input: UpdateCartInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.cartId | \nID! | \nSim | \n— | \n_id do carrinho a atualizar. | \n
\n\ninput.cartToken | \nString | \nSim, se o carrinho for anônimo (ex.: criado por createCartByTemplate) | \nnull | \nToken retornado na criação do carrinho. Obrigatório para acessar um carrinho sem conta vinculada. | \n
\n\ninput.paymentMethod | \nPaymentMethodName | \nNão | \n— | \nForma de pagamento a aplicar. Envie null explicitamente para limpar a forma de pagamento já definida. | \n
\n\ninput.numberOfInstallments | \nInt | \nSim, quando paymentMethod é uma forma de crédito parcelado | \n— | \nNúmero de parcelas. Deve ser um inteiro ≥ 1. | \n
\n\ninput.recurringItemsFrequencyId | \nString | \nNão | \n— | \nID de uma frequência de recorrência (ver getInstallments/catálogo de recorrência). Envie null explicitamente para remover a recorrência já definida. | \n
\n\n
\n
Retorno
\nUpdateCartPayload!:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ncart | \nCart! | \nO carrinho já atualizado. | \n
\n\ncartEvents | \n[CartEvent] | \nEventos relevantes ocorridos como efeito colateral desta atualização, se houver. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nNOT_FOUND | \nNenhum carrinho ativo (isLocked: false) casa com cartId (e cartToken, quando enviado). | \nConfira o cartId/cartToken; carrinhos travados (em checkout) ou inexistentes não são encontrados. | \n
\n\nFORBIDDEN_ERROR | \nO carrinho pertence a uma conta diferente da conta autenticada na chamada. | \nAutentique-se com a conta dona do carrinho, ou use o cartToken correto se o carrinho for anônimo. | \n
\n\n| — | \nCampo obrigatório ausente/inválido (ex.: numberOfInstallments ausente com forma de pagamento de crédito parcelado). | \nCorrija o input conforme a tabela acima; verifique message (sem extensions.code estável). | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Atualização parcial, não substituição completa. Só os campos presentes no
input são alterados; para limpar um valor já definido (ex.: remover a forma de pagamento), envie o campo explicitamente como null — omiti-lo mantém o valor atual. \nblockPaymentMethodChange no carrinho pode travar a troca da forma de pagamento. Se o carrinho (herdado do template que o originou, por exemplo) tiver blockPaymentMethodChange: true, o paymentMethod/numberOfInstallments enviados são ignorados silenciosamente — a chamada não retorna erro, mas o carrinho retornado mantém a forma de pagamento anterior.- Carrinhos anônimos exigem
cartToken; carrinhos de conta exigem a mesma conta autenticada. Não existe uma terceira via de acesso — perder o cartToken de um carrinho anônimo o torna inacessível por esta operação. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c558f7c4-1f2c-454c-838b-ccb1626af32a","name":"200 - updateCart","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCart($input: UpdateCartInput!) {\n updateCart(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"cartId\": \"{{cartId}}\",\n \"cartToken\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"numberOfInstallments\": 10\n }\n}"}},"url":"{{base_url}}","description":"## updateCart\n\n**Propósito:** Atualiza a forma de pagamento, o número de parcelas e/ou a frequência de recorrência de um carrinho existente.\n**Quando usar:** Depois de criar um carrinho (por exemplo, com `createCartByTemplate`), para definir ou trocar como o comprador vai pagar antes de fechar o pedido. **É idempotente para o mesmo conjunto de valores**: reenviar o mesmo `input` sobre o mesmo carrinho aplica o mesmo estado novamente sem efeito colateral adicional; porém, como é uma atualização parcial, cada chamada só altera os campos que você enviar — campos omitidos permanecem com o valor atual do carrinho.\n**Autenticação:** `x-api-key` + `Authorization`. Se o carrinho pertencer a uma conta (não for anônimo), você precisa estar autenticado como essa mesma conta — caso contrário a chamada falha com `FORBIDDEN_ERROR`. Para carrinhos anônimos (por exemplo, criados por `createCartByTemplate`), a validação é feita pelo `cartToken`, não pela conta.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateCartInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------- | ------------------- | ----------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.cartId` | `ID!` | Sim | — | `_id` do carrinho a atualizar. |\n| `input.cartToken` | `String` | Sim, se o carrinho for anônimo (ex.: criado por `createCartByTemplate`) | `null` | Token retornado na criação do carrinho. Obrigatório para acessar um carrinho sem conta vinculada. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Forma de pagamento a aplicar. Envie `null` explicitamente para limpar a forma de pagamento já definida. |\n| `input.numberOfInstallments` | `Int` | Sim, quando `paymentMethod` é uma forma de crédito parcelado | — | Número de parcelas. Deve ser um inteiro ≥ 1. |\n| `input.recurringItemsFrequencyId` | `String` | Não | — | ID de uma frequência de recorrência (ver `getInstallments`/catálogo de recorrência). Envie `null` explicitamente para remover a recorrência já definida. |\n\n### Retorno\n\n`UpdateCartPayload!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | ------------- | -------------------------------------------------------------------------------- |\n| `cart` | `Cart!` | O carrinho já atualizado. |\n| `cartEvents` | `[CartEvent]` | Eventos relevantes ocorridos como efeito colateral desta atualização, se houver. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| `NOT_FOUND` | Nenhum carrinho ativo (`isLocked: false`) casa com `cartId` (e `cartToken`, quando enviado). | Confira o `cartId`/`cartToken`; carrinhos travados (em checkout) ou inexistentes não são encontrados. |\n| `FORBIDDEN_ERROR` | O carrinho pertence a uma conta diferente da conta autenticada na chamada. | Autentique-se com a conta dona do carrinho, ou use o `cartToken` correto se o carrinho for anônimo. |\n| — | Campo obrigatório ausente/inválido (ex.: `numberOfInstallments` ausente com forma de pagamento de crédito parcelado). | Corrija o `input` conforme a tabela acima; verifique `message` (sem `extensions.code` estável). |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Atualização parcial, não substituição completa.** Só os campos presentes no `input` são alterados; para limpar um valor já definido (ex.: remover a forma de pagamento), envie o campo explicitamente como `null` — omiti-lo mantém o valor atual.\n- **`blockPaymentMethodChange` no carrinho pode travar a troca da forma de pagamento.** Se o carrinho (herdado do template que o originou, por exemplo) tiver `blockPaymentMethodChange: true`, o `paymentMethod`/`numberOfInstallments` enviados são ignorados silenciosamente — a chamada não retorna erro, mas o carrinho retornado mantém a forma de pagamento anterior.\n- **Carrinhos anônimos exigem `cartToken`; carrinhos de conta exigem a mesma conta autenticada.** Não existe uma terceira via de acesso — perder o `cartToken` de um carrinho anônimo o torna inacessível por esta operação."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateCart\": {\n \"cart\": {\n \"_id\": \"Example_ID\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"email\": \"cliente@exemplo.com\",\n \"expiresAt\": \"2025-01-15T10:00:00Z\",\n \"referenceId\": \"Example_String\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"totalItemQuantity\": 10,\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"blockPaymentMethodChange\": true,\n \"numberOfInstallments\": 10\n },\n \"cartEvents\": [\n {\n \"type\": \"SALE_FREE_ITEM_ADDED\",\n \"data\": {}\n }\n ]\n }\n }\n}"},{"id":"f24db113-0aa7-480b-a742-8128cbfdd1e5","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCart($input: UpdateCartInput!) {\n updateCart(input: $input) {\n cart {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n checkout {\n fulfillmentGroups {\n _id\n availableFulfillmentOptions {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n data {\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n }\n items {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n originalPrice {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n type\n }\n summary {\n discountSummary {\n itemsRecurrenceDiscount {\n amount\n displayAmount\n }\n compareAtPriceDiscount {\n amount\n displayAmount\n }\n totalDiscountCodeAmount {\n amount\n displayAmount\n }\n fromKitItemDiscount {\n amount\n displayAmount\n }\n totalAmount {\n amount\n displayAmount\n }\n }\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n recurrenceItemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n createdAt\n email\n expiresAt\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n missingItems {\n _id\n addedAt\n attributes {\n label\n value\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isVisible\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n recurrenceAllowed\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n minOrderQuantity\n maxOrderQuantity\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n thumbnail\n }\n referenceId\n recurringItemsFrequencyId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n totalItemQuantity\n billing {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n constraints {\n shipping {\n fulfillmentType\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n fulfillmentOptionModifier {\n _id\n name\n label\n description\n classification\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n enabled\n status\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n startDate\n endDate\n }\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n daysRemaining\n }\n }\n }\n updatedAt\n paymentMethod\n blockPaymentMethodChange\n numberOfInstallments\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n cartEvents {\n type\n data\n }\n }\n}","variables":"{\n \"input\": {\n \"cartId\": \"{{cartId}}\",\n \"cartToken\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"numberOfInstallments\": 10\n }\n}"}},"url":"{{base_url}}","description":"## updateCart\n\n**Propósito:** Atualiza a forma de pagamento, o número de parcelas e/ou a frequência de recorrência de um carrinho existente.\n**Quando usar:** Depois de criar um carrinho (por exemplo, com `createCartByTemplate`), para definir ou trocar como o comprador vai pagar antes de fechar o pedido. **É idempotente para o mesmo conjunto de valores**: reenviar o mesmo `input` sobre o mesmo carrinho aplica o mesmo estado novamente sem efeito colateral adicional; porém, como é uma atualização parcial, cada chamada só altera os campos que você enviar — campos omitidos permanecem com o valor atual do carrinho.\n**Autenticação:** `x-api-key` + `Authorization`. Se o carrinho pertencer a uma conta (não for anônimo), você precisa estar autenticado como essa mesma conta — caso contrário a chamada falha com `FORBIDDEN_ERROR`. Para carrinhos anônimos (por exemplo, criados por `createCartByTemplate`), a validação é feita pelo `cartToken`, não pela conta.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateCartInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------- | ------------------- | ----------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.cartId` | `ID!` | Sim | — | `_id` do carrinho a atualizar. |\n| `input.cartToken` | `String` | Sim, se o carrinho for anônimo (ex.: criado por `createCartByTemplate`) | `null` | Token retornado na criação do carrinho. Obrigatório para acessar um carrinho sem conta vinculada. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Forma de pagamento a aplicar. Envie `null` explicitamente para limpar a forma de pagamento já definida. |\n| `input.numberOfInstallments` | `Int` | Sim, quando `paymentMethod` é uma forma de crédito parcelado | — | Número de parcelas. Deve ser um inteiro ≥ 1. |\n| `input.recurringItemsFrequencyId` | `String` | Não | — | ID de uma frequência de recorrência (ver `getInstallments`/catálogo de recorrência). Envie `null` explicitamente para remover a recorrência já definida. |\n\n### Retorno\n\n`UpdateCartPayload!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------ | ------------- | -------------------------------------------------------------------------------- |\n| `cart` | `Cart!` | O carrinho já atualizado. |\n| `cartEvents` | `[CartEvent]` | Eventos relevantes ocorridos como efeito colateral desta atualização, se houver. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| `NOT_FOUND` | Nenhum carrinho ativo (`isLocked: false`) casa com `cartId` (e `cartToken`, quando enviado). | Confira o `cartId`/`cartToken`; carrinhos travados (em checkout) ou inexistentes não são encontrados. |\n| `FORBIDDEN_ERROR` | O carrinho pertence a uma conta diferente da conta autenticada na chamada. | Autentique-se com a conta dona do carrinho, ou use o `cartToken` correto se o carrinho for anônimo. |\n| — | Campo obrigatório ausente/inválido (ex.: `numberOfInstallments` ausente com forma de pagamento de crédito parcelado). | Corrija o `input` conforme a tabela acima; verifique `message` (sem `extensions.code` estável). |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Atualização parcial, não substituição completa.** Só os campos presentes no `input` são alterados; para limpar um valor já definido (ex.: remover a forma de pagamento), envie o campo explicitamente como `null` — omiti-lo mantém o valor atual.\n- **`blockPaymentMethodChange` no carrinho pode travar a troca da forma de pagamento.** Se o carrinho (herdado do template que o originou, por exemplo) tiver `blockPaymentMethodChange: true`, o `paymentMethod`/`numberOfInstallments` enviados são ignorados silenciosamente — a chamada não retorna erro, mas o carrinho retornado mantém a forma de pagamento anterior.\n- **Carrinhos anônimos exigem `cartToken`; carrinhos de conta exigem a mesma conta autenticada.** Não existe uma terceira via de acesso — perder o `cartToken` de um carrinho anônimo o torna inacessível por esta operação."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"11dceca8-ef8a-5770-b638-0d30b87c8511"},{"name":"[Mutation] createCartTemplateFromCart","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns createCartTemplateFromCart data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"createCartTemplateFromCart\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"d50d1043-78e1-53d5-b3a2-ba8b32c4e68e","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplateFromCart($cartId: String) {\n createCartTemplateFromCart(cartId: $cartId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartId\": \"{{cartId}}\"\n}"}},"url":"{{base_url}}","description":"createCartTemplateFromCart
\nPropósito: Cria um template de carrinho novo a partir dos itens e do desconto de um carrinho existente, para reaproveitar aquela combinação depois.\nQuando usar: Quando você já tem um carrinho montado (por exemplo, um carrinho recorrente ou de um pedido de sucesso) e quer transformá-lo num template reutilizável, em vez de remontar os itens manualmente em createCartTemplate. Não é idempotente: cada chamada cria um template novo, mesmo enviando o mesmo cartId — chamar duas vezes gera dois templates distintos com o mesmo conteúdo.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada, e o carrinho buscado é restrito a essa loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ncartId | \nString | \nSim | \n— | \n_id do carrinho de origem, na sua loja. | \n
\n\n
\n
Retorno
\nCartTemplate — mesma forma retornada pela query cartTemplate (ver essa página para a tabela completa de campos).
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nCART_NOT_FOUND_ERROR | \nNão existe carrinho ativo (isLocked: false) com o cartId informado na sua loja. | \nConfira o cartId; carrinhos travados (em checkout) ou de outra loja não são encontrados. | \n
\n\nCART_EMPTY_ERROR | \nO carrinho de origem não tem itens. | \nUse um carrinho com ao menos um item. | \n
\n\nCART_PRODUCT_NOT_FOUND_ERROR | \nAlgum item do carrinho referencia um produto que não existe mais no catálogo. | \nRemova/atualize esse item no carrinho antes de gerar o template, ou monte o template manualmente com createCartTemplate. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Enviar cartId ausente ou vazio retorna um erro de validação com mensagem descritiva, sem extensions.code estável.
\n
\nNotas
\n\n- Não é idempotente. Repetir a chamada com o mesmo
cartId cria um novo template a cada vez. \n- O template herda o desconto do carrinho, não o desconto por código. Se o carrinho tiver um desconto aplicado, o template criado referencia esse mesmo desconto — mas não herda frete, forma de pagamento ou as flags
blockPaymentMethodChange/blockApplyDiscountCode/blockApplyShopSale do carrinho; se precisar delas no template, configure-as depois com updateCartTemplate. \n- A frequência de recorrência é herdada quando o carrinho de origem tem uma configurada (
recurringItemsFrequencyId); caso contrário, o template é criado sem recorrência. \n- O template criado começa sempre com
status: ACTIVE. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5b9da72c-723b-4d42-930c-961da7f340a2","name":"200 - createCartTemplateFromCart","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplateFromCart($cartId: String) {\n createCartTemplateFromCart(cartId: $cartId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartId\": \"{{cartId}}\"\n}"}},"url":"{{base_url}}","description":"## createCartTemplateFromCart\n\n**Propósito:** Cria um template de carrinho novo a partir dos itens e do desconto de um carrinho existente, para reaproveitar aquela combinação depois.\n**Quando usar:** Quando você já tem um carrinho montado (por exemplo, um carrinho recorrente ou de um pedido de sucesso) e quer transformá-lo num template reutilizável, em vez de remontar os itens manualmente em `createCartTemplate`. **Não é idempotente**: cada chamada cria um template novo, mesmo enviando o mesmo `cartId` — chamar duas vezes gera dois templates distintos com o mesmo conteúdo.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada, e o carrinho buscado é restrito a essa loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------- | -------- | ----------- | ------- | ----------------------------------------- |\n| `cartId` | `String` | Sim | — | `_id` do carrinho de origem, na sua loja. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| `CART_NOT_FOUND_ERROR` | Não existe carrinho ativo (`isLocked: false`) com o `cartId` informado na sua loja. | Confira o `cartId`; carrinhos travados (em checkout) ou de outra loja não são encontrados. |\n| `CART_EMPTY_ERROR` | O carrinho de origem não tem itens. | Use um carrinho com ao menos um item. |\n| `CART_PRODUCT_NOT_FOUND_ERROR` | Algum item do carrinho referencia um produto que não existe mais no catálogo. | Remova/atualize esse item no carrinho antes de gerar o template, ou monte o template manualmente com `createCartTemplate`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartId` ausente ou vazio retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Não é idempotente.** Repetir a chamada com o mesmo `cartId` cria um novo template a cada vez.\n- **O template herda o desconto do carrinho, não o desconto por código.** Se o carrinho tiver um desconto aplicado, o template criado referencia esse mesmo desconto — mas não herda frete, forma de pagamento ou as flags `blockPaymentMethodChange`/`blockApplyDiscountCode`/`blockApplyShopSale` do carrinho; se precisar delas no template, configure-as depois com `updateCartTemplate`.\n- **A frequência de recorrência é herdada quando o carrinho de origem tem uma configurada** (`recurringItemsFrequencyId`); caso contrário, o template é criado sem recorrência.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createCartTemplateFromCart\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"totalAmount\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"ordersCount\": 10,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\"\n },\n \"items\": [\n {\n \"quantity\": 1,\n \"isRecurring\": true,\n \"isVisible\": true\n }\n ],\n \"discount\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n },\n \"recurringItemsFrequency\": {\n \"_id\": \"Example_String\",\n \"title\": \"Example_String\",\n \"periodicity\": \"DAY\",\n \"interval\": 10\n },\n \"paymentMethod\": {},\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n}"},{"id":"9f0cc3ee-6905-428e-bfcc-55bbad24d422","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplateFromCart($cartId: String) {\n createCartTemplateFromCart(cartId: $cartId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartId\": \"{{cartId}}\"\n}"}},"url":"{{base_url}}","description":"## createCartTemplateFromCart\n\n**Propósito:** Cria um template de carrinho novo a partir dos itens e do desconto de um carrinho existente, para reaproveitar aquela combinação depois.\n**Quando usar:** Quando você já tem um carrinho montado (por exemplo, um carrinho recorrente ou de um pedido de sucesso) e quer transformá-lo num template reutilizável, em vez de remontar os itens manualmente em `createCartTemplate`. **Não é idempotente**: cada chamada cria um template novo, mesmo enviando o mesmo `cartId` — chamar duas vezes gera dois templates distintos com o mesmo conteúdo.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada, e o carrinho buscado é restrito a essa loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------- | -------- | ----------- | ------- | ----------------------------------------- |\n| `cartId` | `String` | Sim | — | `_id` do carrinho de origem, na sua loja. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| `CART_NOT_FOUND_ERROR` | Não existe carrinho ativo (`isLocked: false`) com o `cartId` informado na sua loja. | Confira o `cartId`; carrinhos travados (em checkout) ou de outra loja não são encontrados. |\n| `CART_EMPTY_ERROR` | O carrinho de origem não tem itens. | Use um carrinho com ao menos um item. |\n| `CART_PRODUCT_NOT_FOUND_ERROR` | Algum item do carrinho referencia um produto que não existe mais no catálogo. | Remova/atualize esse item no carrinho antes de gerar o template, ou monte o template manualmente com `createCartTemplate`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartId` ausente ou vazio retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Não é idempotente.** Repetir a chamada com o mesmo `cartId` cria um novo template a cada vez.\n- **O template herda o desconto do carrinho, não o desconto por código.** Se o carrinho tiver um desconto aplicado, o template criado referencia esse mesmo desconto — mas não herda frete, forma de pagamento ou as flags `blockPaymentMethodChange`/`blockApplyDiscountCode`/`blockApplyShopSale` do carrinho; se precisar delas no template, configure-as depois com `updateCartTemplate`.\n- **A frequência de recorrência é herdada quando o carrinho de origem tem uma configurada** (`recurringItemsFrequencyId`); caso contrário, o template é criado sem recorrência.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"d02692ee-5111-416e-85e7-3267c7deb238","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplateFromCart($cartId: String) {\n createCartTemplateFromCart(cartId: $cartId) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"cartId\": \"{{cartId}}\"\n}"}},"url":"{{base_url}}","description":"## createCartTemplateFromCart\n\n**Propósito:** Cria um template de carrinho novo a partir dos itens e do desconto de um carrinho existente, para reaproveitar aquela combinação depois.\n**Quando usar:** Quando você já tem um carrinho montado (por exemplo, um carrinho recorrente ou de um pedido de sucesso) e quer transformá-lo num template reutilizável, em vez de remontar os itens manualmente em `createCartTemplate`. **Não é idempotente**: cada chamada cria um template novo, mesmo enviando o mesmo `cartId` — chamar duas vezes gera dois templates distintos com o mesmo conteúdo.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada, e o carrinho buscado é restrito a essa loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------- | -------- | ----------- | ------- | ----------------------------------------- |\n| `cartId` | `String` | Sim | — | `_id` do carrinho de origem, na sua loja. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |\n| `CART_NOT_FOUND_ERROR` | Não existe carrinho ativo (`isLocked: false`) com o `cartId` informado na sua loja. | Confira o `cartId`; carrinhos travados (em checkout) ou de outra loja não são encontrados. |\n| `CART_EMPTY_ERROR` | O carrinho de origem não tem itens. | Use um carrinho com ao menos um item. |\n| `CART_PRODUCT_NOT_FOUND_ERROR` | Algum item do carrinho referencia um produto que não existe mais no catálogo. | Remova/atualize esse item no carrinho antes de gerar o template, ou monte o template manualmente com `createCartTemplate`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartId` ausente ou vazio retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Não é idempotente.** Repetir a chamada com o mesmo `cartId` cria um novo template a cada vez.\n- **O template herda o desconto do carrinho, não o desconto por código.** Se o carrinho tiver um desconto aplicado, o template criado referencia esse mesmo desconto — mas não herda frete, forma de pagamento ou as flags `blockPaymentMethodChange`/`blockApplyDiscountCode`/`blockApplyShopSale` do carrinho; se precisar delas no template, configure-as depois com `updateCartTemplate`.\n- **A frequência de recorrência é herdada quando o carrinho de origem tem uma configurada** (`recurringItemsFrequencyId`); caso contrário, o template é criado sem recorrência.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"d50d1043-78e1-53d5-b3a2-ba8b32c4e68e"},{"name":"[Mutation] updateCartTemplate","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns updateCartTemplate data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"updateCartTemplate\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"c2760721-b5e7-51ac-ac0e-b8dd1f5cccbd","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCartTemplate($input: UpdateCartTemplateInput) {\n updateCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"cartTemplateId\": \"Example_ID\",\n \"title\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isDeleted\": true,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"updateCartTemplate
\nPropósito: Atualiza campos de um template de carrinho existente — título, status, restrições, forma de pagamento e as flags de bloqueio — ou o exclui (soft-delete).\nQuando usar: Para pausar/reativar um template (status), ajustar seu limite de uso ou data de expiração (constraints), ou removê-lo definitivamente da sua lista de templates ativos (isDeleted: true). É uma atualização parcial: só os campos enviados são alterados; é idempotente para o mesmo conjunto de valores, com uma exceção importante — ver Notas sobre excluir um template já excluído.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada.
\nArgumentos
\nÚnico argumento: input: UpdateCartTemplateInput.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.cartTemplateId | \nID! | \nSim | \n— | \n_id do template a atualizar. | \n
\n\ninput.title | \nString | \nNão | \n— | \nNovo título. | \n
\n\ninput.status | \nCartTemplateStatus | \nNão | \n— | \nACTIVE ou PAUSED. | \n
\n\ninput.isDeleted | \nBoolean | \nNão | \n— | \nEnvie true para excluir o template (soft-delete). Ver Notas — não há operação para reverter. | \n
\n\ninput.constraints | \nCheckoutTemplateConstraintsInput | \nNão | \n— | \n{ usageLimit: Int, expirationDate: AWSDateTime }. Envie o objeto completo — ver Notas. | \n
\n\ninput.paymentMethod | \nPaymentMethodName | \nNão | \n— | \nNova forma de pagamento a fixar no template. | \n
\n\ninput.blockPaymentMethodChange | \nBoolean | \nNão | \n— | \nSe true, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. | \n
\n\ninput.blockApplyDiscountCode | \nBoolean | \nNão | \n— | \nSe true, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. | \n
\n\ninput.blockApplyShopSale | \nBoolean | \nNão | \n— | \nSe true, promoções da loja não são aplicadas automaticamente. | \n
\n\n
\n
Retorno
\nCartTemplate — mesma forma retornada pela query cartTemplate (ver essa página para a tabela completa de campos). Quando isDeleted: true é enviado, o objeto retornado ainda reflete o estado final do template no momento da exclusão.
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nUNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR | \nNão existe template não-excluído com o cartTemplateId informado na sua loja (inclui o caso de já estar excluído). | \nConfira o cartTemplateId; um template já excluído não pode ser atualizado novamente. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Enviar cartTemplateId ausente, ou um status fora de ACTIVE/PAUSED, retorna um erro de validação com mensagem descritiva, sem extensions.code estável.
\n
\nNotas
\n\n- Atualização parcial (
$set), não substituição completa. Apenas os campos presentes no input são alterados — campos omitidos mantêm o valor já salvo no template. Isso vale inclusive para objetos aninhados como constraints: enviar constraints: { usageLimit: 10 } substitui o objeto constraints inteiro (não faz merge campo a campo dentro dele), então inclua todos os subcampos que devem permanecer. \nisDeleted: true é soft-delete e não é idempotente. A primeira chamada com isDeleted: true exclui o template. Chamar novamente sobre o mesmo cartTemplateId falha com UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR, porque a busca interna já exclui templates com isDeleted: true — trate esse erro como \"já estava excluído\", não necessariamente como falha real.- Não há operação para reverter uma exclusão. Depois de
isDeleted: true, o template para de aparecer em cartTemplate/cartTemplates e não pode mais ser usado em createCartByTemplate (CART_TEMPLATE_NOT_FOUND_ERROR) nem atualizado novamente. \n- Templates pausados (
status: PAUSED) continuam podendo ser atualizados (incluindo reativados com status: ACTIVE) — só createCartByTemplate é bloqueado para templates pausados, não updateCartTemplate. \n- Falha ao limpar a opção de frete do template excluído é best-effort e não é reportada ao cliente. Ao excluir o template (
isDeleted: true), se a Unbox não conseguir limpar a opção de frete específica vinculada a ele, o erro (COULD_NOT_DELETE_CART_TEMPLATE_FULFILLMENT_OPTION_MODIFIER_ERROR) é apenas logado internamente (Logger.error) — nunca aparece em errors[] da resposta. O template é excluído normalmente mesmo assim; nenhuma ação necessária de sua parte. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0cd14562-2f3a-4b18-9e3d-ed06733d473d","name":"200 - updateCartTemplate","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCartTemplate($input: UpdateCartTemplateInput) {\n updateCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"cartTemplateId\": \"Example_ID\",\n \"title\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isDeleted\": true,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## updateCartTemplate\n\n**Propósito:** Atualiza campos de um template de carrinho existente — título, status, restrições, forma de pagamento e as flags de bloqueio — ou o exclui (soft-delete).\n**Quando usar:** Para pausar/reativar um template (`status`), ajustar seu limite de uso ou data de expiração (`constraints`), ou removê-lo definitivamente da sua lista de templates ativos (`isDeleted: true`). **É uma atualização parcial**: só os campos enviados são alterados; é idempotente para o mesmo conjunto de valores, com uma exceção importante — ver Notas sobre excluir um template já excluído.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateCartTemplateInput`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------------- | ---------------------------------- | ----------- | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.cartTemplateId` | `ID!` | Sim | — | `_id` do template a atualizar. |\n| `input.title` | `String` | Não | — | Novo título. |\n| `input.status` | `CartTemplateStatus` | Não | — | `ACTIVE` ou `PAUSED`. |\n| `input.isDeleted` | `Boolean` | Não | — | Envie `true` para excluir o template (soft-delete). Ver Notas — não há operação para reverter. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | — | `{ usageLimit: Int, expirationDate: AWSDateTime }`. Envie o objeto completo — ver Notas. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Nova forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | — | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | — | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | — | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos). Quando `isDeleted: true` é enviado, o objeto retornado ainda reflete o estado final do template no momento da exclusão.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja (inclui o caso de já estar excluído). | Confira o `cartTemplateId`; um template já excluído não pode ser atualizado novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartTemplateId` ausente, ou um `status` fora de `ACTIVE`/`PAUSED`, retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Atualização parcial (`$set`), não substituição completa.** Apenas os campos presentes no `input` são alterados — campos omitidos mantêm o valor já salvo no template. Isso vale inclusive para objetos aninhados como `constraints`: enviar `constraints: { usageLimit: 10 }` substitui o objeto `constraints` inteiro (não faz merge campo a campo dentro dele), então inclua todos os subcampos que devem permanecer.\n- **`isDeleted: true` é soft-delete e não é idempotente.** A primeira chamada com `isDeleted: true` exclui o template. Chamar novamente sobre o mesmo `cartTemplateId` falha com `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR`, porque a busca interna já exclui templates com `isDeleted: true` — trate esse erro como \"já estava excluído\", não necessariamente como falha real.\n- **Não há operação para reverter uma exclusão.** Depois de `isDeleted: true`, o template para de aparecer em `cartTemplate`/`cartTemplates` e não pode mais ser usado em `createCartByTemplate` (`CART_TEMPLATE_NOT_FOUND_ERROR`) nem atualizado novamente.\n- **Templates pausados (`status: PAUSED`) continuam podendo ser atualizados** (incluindo reativados com `status: ACTIVE`) — só `createCartByTemplate` é bloqueado para templates pausados, não `updateCartTemplate`.\n- **Falha ao limpar a opção de frete do template excluído é best-effort e não é reportada ao cliente.** Ao excluir o template (`isDeleted: true`), se a Unbox não conseguir limpar a opção de frete específica vinculada a ele, o erro (`COULD_NOT_DELETE_CART_TEMPLATE_FULFILLMENT_OPTION_MODIFIER_ERROR`) é apenas logado internamente (`Logger.error`) — **nunca** aparece em `errors[]` da resposta. O template é excluído normalmente mesmo assim; nenhuma ação necessária de sua parte."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateCartTemplate\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"totalAmount\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"ordersCount\": 10,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\"\n },\n \"items\": [\n {\n \"quantity\": 1,\n \"isRecurring\": true,\n \"isVisible\": true\n }\n ],\n \"discount\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n },\n \"recurringItemsFrequency\": {\n \"_id\": \"Example_String\",\n \"title\": \"Example_String\",\n \"periodicity\": \"DAY\",\n \"interval\": 10\n },\n \"paymentMethod\": {},\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n}"},{"id":"745fddfe-2e9a-4467-a88c-0be9ebcbe676","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCartTemplate($input: UpdateCartTemplateInput) {\n updateCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"cartTemplateId\": \"Example_ID\",\n \"title\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isDeleted\": true,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## updateCartTemplate\n\n**Propósito:** Atualiza campos de um template de carrinho existente — título, status, restrições, forma de pagamento e as flags de bloqueio — ou o exclui (soft-delete).\n**Quando usar:** Para pausar/reativar um template (`status`), ajustar seu limite de uso ou data de expiração (`constraints`), ou removê-lo definitivamente da sua lista de templates ativos (`isDeleted: true`). **É uma atualização parcial**: só os campos enviados são alterados; é idempotente para o mesmo conjunto de valores, com uma exceção importante — ver Notas sobre excluir um template já excluído.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateCartTemplateInput`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------------- | ---------------------------------- | ----------- | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.cartTemplateId` | `ID!` | Sim | — | `_id` do template a atualizar. |\n| `input.title` | `String` | Não | — | Novo título. |\n| `input.status` | `CartTemplateStatus` | Não | — | `ACTIVE` ou `PAUSED`. |\n| `input.isDeleted` | `Boolean` | Não | — | Envie `true` para excluir o template (soft-delete). Ver Notas — não há operação para reverter. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | — | `{ usageLimit: Int, expirationDate: AWSDateTime }`. Envie o objeto completo — ver Notas. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Nova forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | — | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | — | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | — | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos). Quando `isDeleted: true` é enviado, o objeto retornado ainda reflete o estado final do template no momento da exclusão.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja (inclui o caso de já estar excluído). | Confira o `cartTemplateId`; um template já excluído não pode ser atualizado novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartTemplateId` ausente, ou um `status` fora de `ACTIVE`/`PAUSED`, retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Atualização parcial (`$set`), não substituição completa.** Apenas os campos presentes no `input` são alterados — campos omitidos mantêm o valor já salvo no template. Isso vale inclusive para objetos aninhados como `constraints`: enviar `constraints: { usageLimit: 10 }` substitui o objeto `constraints` inteiro (não faz merge campo a campo dentro dele), então inclua todos os subcampos que devem permanecer.\n- **`isDeleted: true` é soft-delete e não é idempotente.** A primeira chamada com `isDeleted: true` exclui o template. Chamar novamente sobre o mesmo `cartTemplateId` falha com `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR`, porque a busca interna já exclui templates com `isDeleted: true` — trate esse erro como \"já estava excluído\", não necessariamente como falha real.\n- **Não há operação para reverter uma exclusão.** Depois de `isDeleted: true`, o template para de aparecer em `cartTemplate`/`cartTemplates` e não pode mais ser usado em `createCartByTemplate` (`CART_TEMPLATE_NOT_FOUND_ERROR`) nem atualizado novamente.\n- **Templates pausados (`status: PAUSED`) continuam podendo ser atualizados** (incluindo reativados com `status: ACTIVE`) — só `createCartByTemplate` é bloqueado para templates pausados, não `updateCartTemplate`.\n- **Falha ao limpar a opção de frete do template excluído é best-effort e não é reportada ao cliente.** Ao excluir o template (`isDeleted: true`), se a Unbox não conseguir limpar a opção de frete específica vinculada a ele, o erro (`COULD_NOT_DELETE_CART_TEMPLATE_FULFILLMENT_OPTION_MODIFIER_ERROR`) é apenas logado internamente (`Logger.error`) — **nunca** aparece em `errors[]` da resposta. O template é excluído normalmente mesmo assim; nenhuma ação necessária de sua parte."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"f0ec7be6-de4a-4c56-a11f-0ae190745aa4","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateCartTemplate($input: UpdateCartTemplateInput) {\n updateCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"cartTemplateId\": \"Example_ID\",\n \"title\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isDeleted\": true,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## updateCartTemplate\n\n**Propósito:** Atualiza campos de um template de carrinho existente — título, status, restrições, forma de pagamento e as flags de bloqueio — ou o exclui (soft-delete).\n**Quando usar:** Para pausar/reativar um template (`status`), ajustar seu limite de uso ou data de expiração (`constraints`), ou removê-lo definitivamente da sua lista de templates ativos (`isDeleted: true`). **É uma atualização parcial**: só os campos enviados são alterados; é idempotente para o mesmo conjunto de valores, com uma exceção importante — ver Notas sobre excluir um template já excluído.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateCartTemplateInput`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------------- | ---------------------------------- | ----------- | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.cartTemplateId` | `ID!` | Sim | — | `_id` do template a atualizar. |\n| `input.title` | `String` | Não | — | Novo título. |\n| `input.status` | `CartTemplateStatus` | Não | — | `ACTIVE` ou `PAUSED`. |\n| `input.isDeleted` | `Boolean` | Não | — | Envie `true` para excluir o template (soft-delete). Ver Notas — não há operação para reverter. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | — | `{ usageLimit: Int, expirationDate: AWSDateTime }`. Envie o objeto completo — ver Notas. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Nova forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | — | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | — | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | — | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos). Quando `isDeleted: true` é enviado, o objeto retornado ainda reflete o estado final do template no momento da exclusão.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR` | Não existe template não-excluído com o `cartTemplateId` informado na sua loja (inclui o caso de já estar excluído). | Confira o `cartTemplateId`; um template já excluído não pode ser atualizado novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Enviar `cartTemplateId` ausente, ou um `status` fora de `ACTIVE`/`PAUSED`, retorna um erro de validação com mensagem descritiva, sem `extensions.code` estável.\n\n### Notas\n\n- **Atualização parcial (`$set`), não substituição completa.** Apenas os campos presentes no `input` são alterados — campos omitidos mantêm o valor já salvo no template. Isso vale inclusive para objetos aninhados como `constraints`: enviar `constraints: { usageLimit: 10 }` substitui o objeto `constraints` inteiro (não faz merge campo a campo dentro dele), então inclua todos os subcampos que devem permanecer.\n- **`isDeleted: true` é soft-delete e não é idempotente.** A primeira chamada com `isDeleted: true` exclui o template. Chamar novamente sobre o mesmo `cartTemplateId` falha com `UNABLE_TO_UPDATE_REQUESTED_CART_TEMPLATE_ERROR`, porque a busca interna já exclui templates com `isDeleted: true` — trate esse erro como \"já estava excluído\", não necessariamente como falha real.\n- **Não há operação para reverter uma exclusão.** Depois de `isDeleted: true`, o template para de aparecer em `cartTemplate`/`cartTemplates` e não pode mais ser usado em `createCartByTemplate` (`CART_TEMPLATE_NOT_FOUND_ERROR`) nem atualizado novamente.\n- **Templates pausados (`status: PAUSED`) continuam podendo ser atualizados** (incluindo reativados com `status: ACTIVE`) — só `createCartByTemplate` é bloqueado para templates pausados, não `updateCartTemplate`.\n- **Falha ao limpar a opção de frete do template excluído é best-effort e não é reportada ao cliente.** Ao excluir o template (`isDeleted: true`), se a Unbox não conseguir limpar a opção de frete específica vinculada a ele, o erro (`COULD_NOT_DELETE_CART_TEMPLATE_FULFILLMENT_OPTION_MODIFIER_ERROR`) é apenas logado internamente (`Logger.error`) — **nunca** aparece em `errors[]` da resposta. O template é excluído normalmente mesmo assim; nenhuma ação necessária de sua parte."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"c2760721-b5e7-51ac-ac0e-b8dd1f5cccbd"},{"name":"[Mutation] createCartTemplate","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns createCartTemplate data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"createCartTemplate\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"40608adb-0dc3-57dd-a792-74956393c2f3","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplate($input: CreateCartTemplateInput!) {\n createCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\",\n \"fulfillmentOptionsIds\": [\n \"Example_ID\"\n ],\n \"shippingValue\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n },\n \"cartItems\": [\n {\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n },\n \"productKitConfiguration\": {\n \"productKitId\": \"Example_ID\",\n \"productKitItemsConfigurations\": [\n {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\",\n \"quantity\": 1\n }\n ]\n },\n \"quantity\": 1,\n \"isRecurring\": true\n }\n ],\n \"discountId\": \"{{discountId}}\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"createCartTemplate
\nPropósito: Cria um template de carrinho — uma configuração reaproveitável de itens, frete, desconto e forma de pagamento — que pode depois virar um carrinho real via createCartByTemplate.\nQuando usar: Para montar antecipadamente uma cesta de compra padronizada (ex.: um kit promocional recorrente) que você vai instanciar como carrinho repetidas vezes. Não é idempotente: cada chamada cria um template novo com um _id/referenceId próprios, mesmo enviando exatamente os mesmos itens e título.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.
\nArgumentos
\nÚnico argumento: input: CreateCartTemplateInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.title | \nString! | \nSim | \n— | \nTítulo do template. | \n
\n\ninput.cartItems | \n[CartTemplateItemsInput!]! | \nSim (mín. 1 item) | \n— | \nItens do template. Ver tabela abaixo. | \n
\n\ninput.discountId | \nID | \nNão | \nnull | \nID de um desconto/código de desconto já existente para vincular ao template. | \n
\n\ninput.constraints | \nCheckoutTemplateConstraintsInput | \nNão | \nnull | \n{ usageLimit: Int, expirationDate: AWSDateTime }. | \n
\n\ninput.shipping | \nCartTemplateShippingInput | \nNão | \n— | \nVer tabela abaixo. Se omitido, o template é criado sem regra de frete específica. | \n
\n\ninput.recurringItemsFrequencyId | \nString | \nSim, se algum item de cartItems tiver isRecurring: true; proibido caso contrário | \n— | \nID de uma frequência de recorrência permitida pela loja. Ver Erros. | \n
\n\ninput.paymentMethod | \nPaymentMethodName | \nNão | \n— | \nForma de pagamento a fixar no template. | \n
\n\ninput.blockPaymentMethodChange | \nBoolean | \nNão | \nfalse | \nSe true, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. | \n
\n\ninput.blockApplyDiscountCode | \nBoolean | \nNão | \nfalse | \nSe true, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. | \n
\n\ninput.blockApplyShopSale | \nBoolean | \nNão | \nfalse | \nSe true, promoções da loja não são aplicadas automaticamente. | \n
\n\n
\n
\n\n\n| Nome | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\nproductConfiguration | \nProductConfigurationInput | \nExatamente um entre este e productKitConfiguration | \n{ productId: ID!, productVariantId: ID! } — produto simples. | \n
\n\nproductKitConfiguration | \nItemKitConfigurationInput | \nExatamente um entre este e productConfiguration | \nConfiguração de um kit de produtos (componentes e variantes escolhidos). | \n
\n\nquantity | \nInt | \nSim para produto simples; opcional para kit (kits usam quantidade 1) | \nQuantidade do item; deve ser inteiro ≥ 1 para produto simples. Para item de kit, se enviado, deve ser 1 — outros valores são rejeitados na validação (não são silenciosamente ignorados). | \n
\n\nisRecurring | \nBoolean | \nNão | \nMarca este item como recorrente. Ver a regra de recurringItemsFrequencyId. | \n
\n\nisVisible | \nBoolean | \nNão | \nControla se o item aparece como visível no carrinho gerado. | \n
\n\n
\n
\n\n\n| Nome | \nTipo | \nObrigatório | \nDescrição | \n
\n\n\n\nfulfillmentType | \nFulfillmentType! | \nSim | \nSHIPPING ou NONE. | \n
\n\nfulfillmentOptionsIds | \n[ID!] | \nProibido se fulfillmentType: NONE; obrigatório (mín. 1) se shippingValue for enviado | \nIDs das opções de frete permitidas para este template. | \n
\n\nshippingValue | \nMoneyInput | \nProibido se fulfillmentType: NONE | \nValor fixo de frete, em formato decimal ({ amount: Float!, currencyCode: String! }). | \n
\n\n
\n
Retorno
\nCartTemplate — mesma forma retornada pela query cartTemplate (ver essa página para a tabela completa de campos, incluindo totalAmount recalculado do catálogo, isSoldOut/isExpired calculados, e itens com produto removido omitidos de items[]).
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nCATALOG_PRODUCT_REQUESTED_NOT_FOUND_ERROR | \nUm productId informado não existe no catálogo da loja. | \nConfira os IDs de produto antes de enviar. | \n
\n\nPRODUCT_DOES_NOT_HAVE_REQUESTED_VARIANT_ERROR | \nUm productVariantId informado não pertence ao productId informado. | \nConfira a combinação produto/variante no catálogo. | \n
\n\nDISCOUNT_CODE_NOT_FOUND_ERROR | \ndiscountId não existe ou não está mais ativo. | \nConfira se o desconto ainda existe e está habilitado. | \n
\n\nDISCOUNT_CODE_CONDITION_ERROR | \nO desconto informado tem condições (valor mínimo, produtos elegíveis etc.) que os cartItems não atendem. | \nAjuste os itens ou escolha outro desconto. | \n
\n\nRECURRENCE_FREQUENCY_INVALID_ERROR | \nAlgum item tem isRecurring: true, mas recurringItemsFrequencyId não foi informado. | \nEnvie um recurringItemsFrequencyId válido junto com itens recorrentes. | \n
\n\nNO_ITEMS_SET_AS_RECURRING_RECEIVED_ERROR | \nrecurringItemsFrequencyId foi informado, mas nenhum item tem isRecurring: true. | \nMarque ao menos um item como isRecurring: true, ou remova recurringItemsFrequencyId. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Campos obrigatórios ausentes ou fora de regra (ex.: cartItems vazio, item enviando productConfiguration e productKitConfiguration ao mesmo tempo) retornam um erro de validação com mensagem descritiva, sem extensions.code estável — verifique sempre message.
\n
\nNotas
\n\n- Não é idempotente. Não há deduplicação por título nem por conjunto de itens — cada chamada cria um novo template com
_id/referenceId próprios. \nproductConfiguration e productKitConfiguration são mutuamente exclusivos por item — enviar os dois (ou nenhum) no mesmo item de cartItems é rejeitado na validação.referenceId é gerado automaticamente pela Unbox, único por loja — não é um campo que você define.- O template criado começa sempre com
status: ACTIVE. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"195820a2-bcec-402a-9060-9744cb9bce8b","name":"200 - createCartTemplate","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplate($input: CreateCartTemplateInput!) {\n createCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\",\n \"fulfillmentOptionsIds\": [\n \"Example_ID\"\n ],\n \"shippingValue\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n },\n \"cartItems\": [\n {\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n },\n \"productKitConfiguration\": {\n \"productKitId\": \"Example_ID\",\n \"productKitItemsConfigurations\": [\n {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\",\n \"quantity\": 1\n }\n ]\n },\n \"quantity\": 1,\n \"isRecurring\": true\n }\n ],\n \"discountId\": \"{{discountId}}\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## createCartTemplate\n\n**Propósito:** Cria um template de carrinho — uma configuração reaproveitável de itens, frete, desconto e forma de pagamento — que pode depois virar um carrinho real via `createCartByTemplate`.\n**Quando usar:** Para montar antecipadamente uma cesta de compra padronizada (ex.: um kit promocional recorrente) que você vai instanciar como carrinho repetidas vezes. **Não é idempotente**: cada chamada cria um template novo com um `_id`/`referenceId` próprios, mesmo enviando exatamente os mesmos itens e título.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateCartTemplateInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------ | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.title` | `String!` | Sim | — | Título do template. |\n| `input.cartItems` | `[CartTemplateItemsInput!]!` | Sim (mín. 1 item) | — | Itens do template. Ver tabela abaixo. |\n| `input.discountId` | `ID` | Não | `null` | ID de um desconto/código de desconto já existente para vincular ao template. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | `null` | `{ usageLimit: Int, expirationDate: AWSDateTime }`. |\n| `input.shipping` | `CartTemplateShippingInput` | Não | — | Ver tabela abaixo. Se omitido, o template é criado sem regra de frete específica. |\n| `input.recurringItemsFrequencyId` | `String` | Sim, se algum item de `cartItems` tiver `isRecurring: true`; proibido caso contrário | — | ID de uma frequência de recorrência permitida pela loja. Ver Erros. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | `false` | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | `false` | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | `false` | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n#### Campos de `input.cartItems[]` (`CartTemplateItemsInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ------------------------- | --------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `productConfiguration` | `ProductConfigurationInput` | Exatamente um entre este e `productKitConfiguration` | `{ productId: ID!, productVariantId: ID! }` — produto simples. |\n| `productKitConfiguration` | `ItemKitConfigurationInput` | Exatamente um entre este e `productConfiguration` | Configuração de um kit de produtos (componentes e variantes escolhidos). |\n| `quantity` | `Int` | Sim para produto simples; opcional para kit (kits usam quantidade 1) | Quantidade do item; deve ser inteiro ≥ 1 para produto simples. Para item de kit, se enviado, deve ser **1** — outros valores são **rejeitados na validação** (não são silenciosamente ignorados). |\n| `isRecurring` | `Boolean` | Não | Marca este item como recorrente. Ver a regra de `recurringItemsFrequencyId`. |\n| `isVisible` | `Boolean` | Não | Controla se o item aparece como visível no carrinho gerado. |\n\n#### Campos de `input.shipping` (`CartTemplateShippingInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ----------------------- | ------------------ | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `fulfillmentType` | `FulfillmentType!` | Sim | `SHIPPING` ou `NONE`. |\n| `fulfillmentOptionsIds` | `[ID!]` | Proibido se `fulfillmentType: NONE`; obrigatório (mín. 1) se `shippingValue` for enviado | IDs das opções de frete permitidas para este template. |\n| `shippingValue` | `MoneyInput` | Proibido se `fulfillmentType: NONE` | Valor fixo de frete, em formato decimal (`{ amount: Float!, currencyCode: String! }`). |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos, incluindo `totalAmount` recalculado do catálogo, `isSoldOut`/`isExpired` calculados, e itens com produto removido omitidos de `items[]`).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `CATALOG_PRODUCT_REQUESTED_NOT_FOUND_ERROR` | Um `productId` informado não existe no catálogo da loja. | Confira os IDs de produto antes de enviar. |\n| `PRODUCT_DOES_NOT_HAVE_REQUESTED_VARIANT_ERROR` | Um `productVariantId` informado não pertence ao `productId` informado. | Confira a combinação produto/variante no catálogo. |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountId` não existe ou não está mais ativo. | Confira se o desconto ainda existe e está habilitado. |\n| `DISCOUNT_CODE_CONDITION_ERROR` | O desconto informado tem condições (valor mínimo, produtos elegíveis etc.) que os `cartItems` não atendem. | Ajuste os itens ou escolha outro desconto. |\n| `RECURRENCE_FREQUENCY_INVALID_ERROR` | Algum item tem `isRecurring: true`, mas `recurringItemsFrequencyId` não foi informado. | Envie um `recurringItemsFrequencyId` válido junto com itens recorrentes. |\n| `NO_ITEMS_SET_AS_RECURRING_RECEIVED_ERROR` | `recurringItemsFrequencyId` foi informado, mas nenhum item tem `isRecurring: true`. | Marque ao menos um item como `isRecurring: true`, ou remova `recurringItemsFrequencyId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Campos obrigatórios ausentes ou fora de regra (ex.: `cartItems` vazio, item enviando `productConfiguration` **e** `productKitConfiguration` ao mesmo tempo) retornam um erro de validação com mensagem descritiva, sem `extensions.code` estável — verifique sempre `message`.\n\n### Notas\n\n- **Não é idempotente.** Não há deduplicação por título nem por conjunto de itens — cada chamada cria um novo template com `_id`/`referenceId` próprios.\n- **`productConfiguration` e `productKitConfiguration` são mutuamente exclusivos por item** — enviar os dois (ou nenhum) no mesmo item de `cartItems` é rejeitado na validação.\n- **`referenceId` é gerado automaticamente pela Unbox**, único por loja — não é um campo que você define.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createCartTemplate\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"totalAmount\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"ordersCount\": 10,\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\"\n },\n \"items\": [\n {\n \"quantity\": 1,\n \"isRecurring\": true,\n \"isVisible\": true\n }\n ],\n \"discount\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n },\n \"recurringItemsFrequency\": {\n \"_id\": \"Example_String\",\n \"title\": \"Example_String\",\n \"periodicity\": \"DAY\",\n \"interval\": 10\n },\n \"paymentMethod\": {},\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n}"},{"id":"72aee682-7de5-462b-b4c5-61cf37b6b217","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplate($input: CreateCartTemplateInput!) {\n createCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\",\n \"fulfillmentOptionsIds\": [\n \"Example_ID\"\n ],\n \"shippingValue\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n },\n \"cartItems\": [\n {\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n },\n \"productKitConfiguration\": {\n \"productKitId\": \"Example_ID\",\n \"productKitItemsConfigurations\": [\n {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\",\n \"quantity\": 1\n }\n ]\n },\n \"quantity\": 1,\n \"isRecurring\": true\n }\n ],\n \"discountId\": \"{{discountId}}\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## createCartTemplate\n\n**Propósito:** Cria um template de carrinho — uma configuração reaproveitável de itens, frete, desconto e forma de pagamento — que pode depois virar um carrinho real via `createCartByTemplate`.\n**Quando usar:** Para montar antecipadamente uma cesta de compra padronizada (ex.: um kit promocional recorrente) que você vai instanciar como carrinho repetidas vezes. **Não é idempotente**: cada chamada cria um template novo com um `_id`/`referenceId` próprios, mesmo enviando exatamente os mesmos itens e título.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateCartTemplateInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------ | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.title` | `String!` | Sim | — | Título do template. |\n| `input.cartItems` | `[CartTemplateItemsInput!]!` | Sim (mín. 1 item) | — | Itens do template. Ver tabela abaixo. |\n| `input.discountId` | `ID` | Não | `null` | ID de um desconto/código de desconto já existente para vincular ao template. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | `null` | `{ usageLimit: Int, expirationDate: AWSDateTime }`. |\n| `input.shipping` | `CartTemplateShippingInput` | Não | — | Ver tabela abaixo. Se omitido, o template é criado sem regra de frete específica. |\n| `input.recurringItemsFrequencyId` | `String` | Sim, se algum item de `cartItems` tiver `isRecurring: true`; proibido caso contrário | — | ID de uma frequência de recorrência permitida pela loja. Ver Erros. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | `false` | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | `false` | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | `false` | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n#### Campos de `input.cartItems[]` (`CartTemplateItemsInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ------------------------- | --------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `productConfiguration` | `ProductConfigurationInput` | Exatamente um entre este e `productKitConfiguration` | `{ productId: ID!, productVariantId: ID! }` — produto simples. |\n| `productKitConfiguration` | `ItemKitConfigurationInput` | Exatamente um entre este e `productConfiguration` | Configuração de um kit de produtos (componentes e variantes escolhidos). |\n| `quantity` | `Int` | Sim para produto simples; opcional para kit (kits usam quantidade 1) | Quantidade do item; deve ser inteiro ≥ 1 para produto simples. Para item de kit, se enviado, deve ser **1** — outros valores são **rejeitados na validação** (não são silenciosamente ignorados). |\n| `isRecurring` | `Boolean` | Não | Marca este item como recorrente. Ver a regra de `recurringItemsFrequencyId`. |\n| `isVisible` | `Boolean` | Não | Controla se o item aparece como visível no carrinho gerado. |\n\n#### Campos de `input.shipping` (`CartTemplateShippingInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ----------------------- | ------------------ | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `fulfillmentType` | `FulfillmentType!` | Sim | `SHIPPING` ou `NONE`. |\n| `fulfillmentOptionsIds` | `[ID!]` | Proibido se `fulfillmentType: NONE`; obrigatório (mín. 1) se `shippingValue` for enviado | IDs das opções de frete permitidas para este template. |\n| `shippingValue` | `MoneyInput` | Proibido se `fulfillmentType: NONE` | Valor fixo de frete, em formato decimal (`{ amount: Float!, currencyCode: String! }`). |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos, incluindo `totalAmount` recalculado do catálogo, `isSoldOut`/`isExpired` calculados, e itens com produto removido omitidos de `items[]`).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `CATALOG_PRODUCT_REQUESTED_NOT_FOUND_ERROR` | Um `productId` informado não existe no catálogo da loja. | Confira os IDs de produto antes de enviar. |\n| `PRODUCT_DOES_NOT_HAVE_REQUESTED_VARIANT_ERROR` | Um `productVariantId` informado não pertence ao `productId` informado. | Confira a combinação produto/variante no catálogo. |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountId` não existe ou não está mais ativo. | Confira se o desconto ainda existe e está habilitado. |\n| `DISCOUNT_CODE_CONDITION_ERROR` | O desconto informado tem condições (valor mínimo, produtos elegíveis etc.) que os `cartItems` não atendem. | Ajuste os itens ou escolha outro desconto. |\n| `RECURRENCE_FREQUENCY_INVALID_ERROR` | Algum item tem `isRecurring: true`, mas `recurringItemsFrequencyId` não foi informado. | Envie um `recurringItemsFrequencyId` válido junto com itens recorrentes. |\n| `NO_ITEMS_SET_AS_RECURRING_RECEIVED_ERROR` | `recurringItemsFrequencyId` foi informado, mas nenhum item tem `isRecurring: true`. | Marque ao menos um item como `isRecurring: true`, ou remova `recurringItemsFrequencyId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Campos obrigatórios ausentes ou fora de regra (ex.: `cartItems` vazio, item enviando `productConfiguration` **e** `productKitConfiguration` ao mesmo tempo) retornam um erro de validação com mensagem descritiva, sem `extensions.code` estável — verifique sempre `message`.\n\n### Notas\n\n- **Não é idempotente.** Não há deduplicação por título nem por conjunto de itens — cada chamada cria um novo template com `_id`/`referenceId` próprios.\n- **`productConfiguration` e `productKitConfiguration` são mutuamente exclusivos por item** — enviar os dois (ou nenhum) no mesmo item de `cartItems` é rejeitado na validação.\n- **`referenceId` é gerado automaticamente pela Unbox**, único por loja — não é um campo que você define.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"b31fbeb8-66b3-4662-9cb7-f370e5b17152","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateCartTemplate($input: CreateCartTemplateInput!) {\n createCartTemplate(input: $input) {\n _id\n referenceId\n type\n shopId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n ordersCount\n constraints {\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n items {\n quantity\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n variant {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n isRecurring\n isVisible\n }\n discount {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n recurringItemsFrequency {\n _id\n title\n periodicity\n interval\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"constraints\": {\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"shipping\": {\n \"fulfillmentType\": \"SHIPPING\",\n \"fulfillmentOptionsIds\": [\n \"Example_ID\"\n ],\n \"shippingValue\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n },\n \"cartItems\": [\n {\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n },\n \"productKitConfiguration\": {\n \"productKitId\": \"Example_ID\",\n \"productKitItemsConfigurations\": [\n {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\",\n \"quantity\": 1\n }\n ]\n },\n \"quantity\": 1,\n \"isRecurring\": true\n }\n ],\n \"discountId\": \"{{discountId}}\",\n \"recurringItemsFrequencyId\": \"Example_String\",\n \"paymentMethod\": \"none\",\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n}"}},"url":"{{base_url}}","description":"## createCartTemplate\n\n**Propósito:** Cria um template de carrinho — uma configuração reaproveitável de itens, frete, desconto e forma de pagamento — que pode depois virar um carrinho real via `createCartByTemplate`.\n**Quando usar:** Para montar antecipadamente uma cesta de compra padronizada (ex.: um kit promocional recorrente) que você vai instanciar como carrinho repetidas vezes. **Não é idempotente**: cada chamada cria um template novo com um `_id`/`referenceId` próprios, mesmo enviando exatamente os mesmos itens e título.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateCartTemplateInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------ | ------- | ----------------------------------------------------------------------------------------------------- |\n| `input.title` | `String!` | Sim | — | Título do template. |\n| `input.cartItems` | `[CartTemplateItemsInput!]!` | Sim (mín. 1 item) | — | Itens do template. Ver tabela abaixo. |\n| `input.discountId` | `ID` | Não | `null` | ID de um desconto/código de desconto já existente para vincular ao template. |\n| `input.constraints` | `CheckoutTemplateConstraintsInput` | Não | `null` | `{ usageLimit: Int, expirationDate: AWSDateTime }`. |\n| `input.shipping` | `CartTemplateShippingInput` | Não | — | Ver tabela abaixo. Se omitido, o template é criado sem regra de frete específica. |\n| `input.recurringItemsFrequencyId` | `String` | Sim, se algum item de `cartItems` tiver `isRecurring: true`; proibido caso contrário | — | ID de uma frequência de recorrência permitida pela loja. Ver Erros. |\n| `input.paymentMethod` | `PaymentMethodName` | Não | — | Forma de pagamento a fixar no template. |\n| `input.blockPaymentMethodChange` | `Boolean` | Não | `false` | Se `true`, carrinhos criados a partir deste template não permitem trocar a forma de pagamento. |\n| `input.blockApplyDiscountCode` | `Boolean` | Não | `false` | Se `true`, códigos de desconto não podem ser aplicados aos carrinhos criados a partir deste template. |\n| `input.blockApplyShopSale` | `Boolean` | Não | `false` | Se `true`, promoções da loja não são aplicadas automaticamente. |\n\n#### Campos de `input.cartItems[]` (`CartTemplateItemsInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ------------------------- | --------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `productConfiguration` | `ProductConfigurationInput` | Exatamente um entre este e `productKitConfiguration` | `{ productId: ID!, productVariantId: ID! }` — produto simples. |\n| `productKitConfiguration` | `ItemKitConfigurationInput` | Exatamente um entre este e `productConfiguration` | Configuração de um kit de produtos (componentes e variantes escolhidos). |\n| `quantity` | `Int` | Sim para produto simples; opcional para kit (kits usam quantidade 1) | Quantidade do item; deve ser inteiro ≥ 1 para produto simples. Para item de kit, se enviado, deve ser **1** — outros valores são **rejeitados na validação** (não são silenciosamente ignorados). |\n| `isRecurring` | `Boolean` | Não | Marca este item como recorrente. Ver a regra de `recurringItemsFrequencyId`. |\n| `isVisible` | `Boolean` | Não | Controla se o item aparece como visível no carrinho gerado. |\n\n#### Campos de `input.shipping` (`CartTemplateShippingInput`)\n\n| Nome | Tipo | Obrigatório | Descrição |\n| ----------------------- | ------------------ | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| `fulfillmentType` | `FulfillmentType!` | Sim | `SHIPPING` ou `NONE`. |\n| `fulfillmentOptionsIds` | `[ID!]` | Proibido se `fulfillmentType: NONE`; obrigatório (mín. 1) se `shippingValue` for enviado | IDs das opções de frete permitidas para este template. |\n| `shippingValue` | `MoneyInput` | Proibido se `fulfillmentType: NONE` | Valor fixo de frete, em formato decimal (`{ amount: Float!, currencyCode: String! }`). |\n\n### Retorno\n\n`CartTemplate` — mesma forma retornada pela query `cartTemplate` (ver essa página para a tabela completa de campos, incluindo `totalAmount` recalculado do catálogo, `isSoldOut`/`isExpired` calculados, e itens com produto removido omitidos de `items[]`).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |\n| `CATALOG_PRODUCT_REQUESTED_NOT_FOUND_ERROR` | Um `productId` informado não existe no catálogo da loja. | Confira os IDs de produto antes de enviar. |\n| `PRODUCT_DOES_NOT_HAVE_REQUESTED_VARIANT_ERROR` | Um `productVariantId` informado não pertence ao `productId` informado. | Confira a combinação produto/variante no catálogo. |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountId` não existe ou não está mais ativo. | Confira se o desconto ainda existe e está habilitado. |\n| `DISCOUNT_CODE_CONDITION_ERROR` | O desconto informado tem condições (valor mínimo, produtos elegíveis etc.) que os `cartItems` não atendem. | Ajuste os itens ou escolha outro desconto. |\n| `RECURRENCE_FREQUENCY_INVALID_ERROR` | Algum item tem `isRecurring: true`, mas `recurringItemsFrequencyId` não foi informado. | Envie um `recurringItemsFrequencyId` válido junto com itens recorrentes. |\n| `NO_ITEMS_SET_AS_RECURRING_RECEIVED_ERROR` | `recurringItemsFrequencyId` foi informado, mas nenhum item tem `isRecurring: true`. | Marque ao menos um item como `isRecurring: true`, ou remova `recurringItemsFrequencyId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Campos obrigatórios ausentes ou fora de regra (ex.: `cartItems` vazio, item enviando `productConfiguration` **e** `productKitConfiguration` ao mesmo tempo) retornam um erro de validação com mensagem descritiva, sem `extensions.code` estável — verifique sempre `message`.\n\n### Notas\n\n- **Não é idempotente.** Não há deduplicação por título nem por conjunto de itens — cada chamada cria um novo template com `_id`/`referenceId` próprios.\n- **`productConfiguration` e `productKitConfiguration` são mutuamente exclusivos por item** — enviar os dois (ou nenhum) no mesmo item de `cartItems` é rejeitado na validação.\n- **`referenceId` é gerado automaticamente pela Unbox**, único por loja — não é um campo que você define.\n- O template criado começa sempre com `status: ACTIVE`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"40608adb-0dc3-57dd-a792-74956393c2f3"}],"id":"1b77eea3-80a5-4ae6-a1d3-ad93eb8b39b6","_postman_id":"1b77eea3-80a5-4ae6-a1d3-ad93eb8b39b6","description":""}],"id":"7f9d5da8-9943-4892-84f3-9f4c63b053c5","description":"Carrinhos e Links de Pagamento
\nOperações para trabalhar com carrinhos, templates de carrinho e links de pagamento. É o fluxo alternativo ao createExternalCheckout (folder \"External Checkout\") para quem monta o carrinho em etapas ou reaproveita configurações via templates.
\nConceitos
\n\n- Payment link (
paymentLink, paymentLinks): o link de checkout hospedado pela Unbox. É o mesmo recurso gerado por createExternalCheckout — use paymentLinks para acompanhar os links criados (status, valores, URL). \n- Cart template (
cartTemplate, cartTemplates, createCartTemplate, createCartTemplateFromCart, updateCartTemplate): um modelo reutilizável de carrinho (itens, descontos, configurações de entrega) a partir do qual carrinhos concretos são criados. \n- Carrinho (
createCartByTemplate, updateCart): a instância concreta de compra, criada a partir de um template. \n
\nPaginação
\nAs listagens (paymentLinks, cartTemplates) usam paginação no padrão Relay: after/before (cursores, String), first/last/offset (Int), sortOrder e sortBy. A resposta traz edges/nodes, pageInfo (hasNextPage/hasPreviousPage/cursores) e totalCount.
\nRegras de negócio
\n\ncreateCartByTemplate não é idempotente: cada chamada cria um novo carrinho. Diferente das demais operações desta API, ela pede shopId explicitamente no input (não é derivado do token) — veja a documentação da operação.- Erros de negócio seguem o padrão GraphQL (HTTP 200 +
errors[]); campos obrigatórios ausentes retornam erro de validação com mensagem descritiva. \n
\n","_postman_id":"7f9d5da8-9943-4892-84f3-9f4c63b053c5"},{"name":"Catalogs","item":[{"name":"Query","item":[{"name":"[Query] productGroup","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns productGroup data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"productGroup\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"productGroup returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.productGroup;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.label !== undefined && data.label !== null) {"," pm.expect(typeof data.label).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"productId\");"," if (data.productId !== undefined && data.productId !== null) {"," pm.expect(typeof data.productId).to.equal(\"string\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"shopId\");"," if (data.shopId !== undefined && data.shopId !== null) {"," pm.expect(typeof data.shopId).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"isActive\");"," if (data.isActive !== undefined && data.isActive !== null) {"," pm.expect(typeof data.isActive).to.equal(\"boolean\");"," }"," if (data.linkedProducts !== undefined && data.linkedProducts !== null) {"," pm.expect(data.linkedProducts).to.be.an(\"array\");"," }"," }","});"]}}],"id":"b9f5ae1e-08d3-52a5-b65f-621d22511137","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroup($input: ProductGroupInput!) {\n productGroup(input: $input) {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n}","variables":"{\n \"input\": {\n \"productId\": \"{{productId}}\",\n \"erpCode\": \"Example_String\",\n \"includeInvalidLinkedProducts\": \"https://exemplo.com\",\n \"includeSoldOutProducts\": true\n }\n}"}},"url":"{{base_url}}","description":"productGroup
\nPropósito: Busca o grupo de produtos vinculados ao produto informado, identificado por productId ou erpCode.\nQuando usar: Ao exibir um produto, para descobrir quais outros produtos do catálogo foram cadastrados como opções relacionadas a ele (ex.: variações vendidas como produtos separados) e montar um seletor ou lista de alternativas. Retorna null (não é erro) quando não existe grupo ativo para o produto informado.\nAutenticação: x-api-key + Authorization. O shopId é injetado a partir do seu token — não envie esse argumento.
\nArgumentos
\nÚnico argumento: input: ProductGroupInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.productId | \nString | \nCondicional | \n— | \nID do produto que representa o grupo. Envie exatamente um entre productId e erpCode (ver Notas). | \n
\n\ninput.erpCode | \nString | \nCondicional | \n— | \nCódigo ERP do produto que representa o grupo. Envie exatamente um entre productId e erpCode (ver Notas). | \n
\n\ninput.includeInvalidLinkedProducts | \nBoolean | \nNão | \nfalse | \nInclui no retorno produtos vinculados cujo catálogo foi excluído ou que estão totalmente esgotados. Ver Notas para o comportamento combinado com includeSoldOutProducts. | \n
\n\ninput.includeSoldOutProducts | \nBoolean | \nNão | \nfalse | \nQuando includeInvalidLinkedProducts não é enviado (comportamento padrão), controla se produtos vinculados totalmente esgotados (todas as variações esgotadas) entram (true) ou não (false) no retorno. | \n
\n\n
\n
Retorno
\nUm ProductGroup, ou null se não existir grupo ativo para o productId/erpCode informado.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nIdentificador do grupo. | \n
\n\nlabel | \nString | \nNome do grupo, pensado para ser exibido ao comprador na hora de escolher entre as opções. | \n
\n\nproductId | \nString! | \nID do produto que representa/possui o grupo. | \n
\n\nerpCode | \nString | \nCódigo ERP do produto que representa o grupo, se cadastrado. | \n
\n\nshopId | \nString! | \nID da sua loja — sempre preenchido no retorno, mesmo que você não envie shopId no argumento. | \n
\n\nisActive | \nBoolean! | \nSempre true quando a operação retorna um grupo (grupos inativos fazem a operação retornar null em vez do objeto). | \n
\n\nlinkedProducts | \n[LinkedProduct]! | \nProdutos vinculados ao grupo. Ver campos abaixo. | \n
\n\nlinkedProducts[].productId | \nString! | \nID do produto vinculado. | \n
\n\nlinkedProducts[].erpCode | \nString | \nCódigo ERP do produto vinculado, se cadastrado. | \n
\n\nlinkedProducts[].title | \nString! | \nTítulo do produto vinculado, congelado no momento em que o vínculo foi criado. | \n
\n\nlinkedProducts[].label | \nString | \nNome para exibição do produto vinculado dentro do grupo (pode diferir de title). | \n
\n\nlinkedProducts[].slug | \nString! | \nSlug do produto vinculado, congelado no momento em que o vínculo foi criado. | \n
\n\nlinkedProducts[].imageUrls | \n[String] | \nURLs das imagens do produto vinculado, obtidas do catálogo atual. | \n
\n\nlinkedProducts[].catalog | \nCatalogProduct | \nEstado atual do produto vinculado no catálogo. null se o produto vinculado foi excluído do catálogo ou nunca existiu. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \ninput enviado sem productId nem erpCode, ou com os dois ao mesmo tempo. | \nErro de validação com mensagem descritiva. Envie exatamente um dos dois. | \n
\n\n| (sem código) | \nA loja da conta autenticada não pôde ser resolvida (SHOP_NOT_FOUND_ERROR). | \nConfirme que sua conta está associada a uma loja ativa e que o access_token é válido; se persistir, contate seu contato Unbox. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Estes erros chegam via errors[].message (texto descritivo) e não garantem um extensions.code estável — verifique sempre message. Falhas de autenticação (access_token ausente ou expirado) seguem o padrão geral descrito na Overview.
\n
\nNotas
\n\n- Envie exatamente um entre
productId e erpCode. Omitir os dois ou enviar os dois ao mesmo tempo é rejeitado na validação. \n- Comportamento padrão (sem flags): o grupo retorna apenas produtos vinculados cujo catálogo existe, não foi excluído e tem ao menos uma variação disponível (não totalmente esgotado).
\nincludeInvalidLinkedProducts: true desliga esse filtro por completo — o grupo passa a retornar todos os produtos vinculados cadastrados, incluindo os com catálogo excluído ou totalmente esgotados. Nesse modo, includeSoldOutProducts não tem efeito adicional (o filtro de esgotado já está desligado).linkedProducts[].catalog é resolvido de forma independente dos filtros acima, item a item. No comportamento padrão isso raramente aparece, pois produtos sem catálogo válido já são removidos de linkedProducts antes de chegar aí; mas com includeInvalidLinkedProducts: true você pode ver itens em linkedProducts cujo catalog vem null (produto removido do catálogo), mesmo com title/slug ainda preenchidos.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cdc3c7ec-7c85-442f-9a73-06cda2846fea","name":"200 - productGroup","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroup($input: ProductGroupInput!) {\n productGroup(input: $input) {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n}","variables":"{\n \"input\": {\n \"productId\": \"{{productId}}\",\n \"erpCode\": \"Example_String\",\n \"includeInvalidLinkedProducts\": \"https://exemplo.com\",\n \"includeSoldOutProducts\": true\n }\n}"}},"url":"{{base_url}}","description":"## productGroup\n\n**Propósito:** Busca o grupo de produtos vinculados ao produto informado, identificado por `productId` ou `erpCode`.\n**Quando usar:** Ao exibir um produto, para descobrir quais outros produtos do catálogo foram cadastrados como opções relacionadas a ele (ex.: variações vendidas como produtos separados) e montar um seletor ou lista de alternativas. Retorna `null` (não é erro) quando não existe grupo ativo para o produto informado.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\nÚnico argumento: `input: ProductGroupInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------------------ | --------- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input.productId` | `String` | Condicional | — | ID do produto que representa o grupo. Envie exatamente um entre `productId` e `erpCode` (ver Notas). |\n| `input.erpCode` | `String` | Condicional | — | Código ERP do produto que representa o grupo. Envie exatamente um entre `productId` e `erpCode` (ver Notas). |\n| `input.includeInvalidLinkedProducts` | `Boolean` | Não | `false` | Inclui no retorno produtos vinculados cujo catálogo foi excluído ou que estão totalmente esgotados. Ver Notas para o comportamento combinado com `includeSoldOutProducts`. |\n| `input.includeSoldOutProducts` | `Boolean` | Não | `false` | Quando `includeInvalidLinkedProducts` não é enviado (comportamento padrão), controla se produtos vinculados totalmente esgotados (todas as variações esgotadas) entram (`true`) ou não (`false`) no retorno. |\n\n### Retorno\n\nUm `ProductGroup`, ou `null` se não existir grupo ativo para o `productId`/`erpCode` informado.\n\n| Propriedade | Tipo | Descrição |\n| ---------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do grupo. |\n| `label` | `String` | Nome do grupo, pensado para ser exibido ao comprador na hora de escolher entre as opções. |\n| `productId` | `String!` | ID do produto que representa/possui o grupo. |\n| `erpCode` | `String` | Código ERP do produto que representa o grupo, se cadastrado. |\n| `shopId` | `String!` | ID da sua loja — sempre preenchido no retorno, mesmo que você não envie `shopId` no argumento. |\n| `isActive` | `Boolean!` | Sempre `true` quando a operação retorna um grupo (grupos inativos fazem a operação retornar `null` em vez do objeto). |\n| `linkedProducts` | `[LinkedProduct]!` | Produtos vinculados ao grupo. Ver campos abaixo. |\n| `linkedProducts[].productId` | `String!` | ID do produto vinculado. |\n| `linkedProducts[].erpCode` | `String` | Código ERP do produto vinculado, se cadastrado. |\n| `linkedProducts[].title` | `String!` | Título do produto vinculado, congelado no momento em que o vínculo foi criado. |\n| `linkedProducts[].label` | `String` | Nome para exibição do produto vinculado dentro do grupo (pode diferir de `title`). |\n| `linkedProducts[].slug` | `String!` | Slug do produto vinculado, congelado no momento em que o vínculo foi criado. |\n| `linkedProducts[].imageUrls` | `[String]` | URLs das imagens do produto vinculado, obtidas do catálogo atual. |\n| `linkedProducts[].catalog` | `CatalogProduct` | Estado atual do produto vinculado no catálogo. `null` se o produto vinculado foi excluído do catálogo ou nunca existiu. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `input` enviado sem `productId` nem `erpCode`, ou com os dois ao mesmo tempo. | Erro de validação com mensagem descritiva. Envie exatamente um dos dois. |\n| _(sem código)_ | A loja da conta autenticada não pôde ser resolvida (`SHOP_NOT_FOUND_ERROR`). | Confirme que sua conta está associada a uma loja ativa e que o `access_token` é válido; se persistir, contate seu contato Unbox. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Estes erros chegam via `errors[].message` (texto descritivo) e não garantem um `extensions.code` estável — verifique sempre `message`. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n### Notas\n\n- **Envie exatamente um entre `productId` e `erpCode`.** Omitir os dois ou enviar os dois ao mesmo tempo é rejeitado na validação.\n- **Comportamento padrão (sem flags):** o grupo retorna apenas produtos vinculados cujo catálogo existe, não foi excluído e tem ao menos uma variação disponível (não totalmente esgotado).\n- **`includeInvalidLinkedProducts: true` desliga esse filtro por completo** — o grupo passa a retornar todos os produtos vinculados cadastrados, incluindo os com catálogo excluído ou totalmente esgotados. Nesse modo, `includeSoldOutProducts` não tem efeito adicional (o filtro de esgotado já está desligado).\n- **`linkedProducts[].catalog` é resolvido de forma independente dos filtros acima**, item a item. No comportamento padrão isso raramente aparece, pois produtos sem catálogo válido já são removidos de `linkedProducts` antes de chegar aí; mas com `includeInvalidLinkedProducts: true` você pode ver itens em `linkedProducts` cujo `catalog` vem `null` (produto removido do catálogo), mesmo com `title`/`slug` ainda preenchidos."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"productGroup\": {\n \"_id\": \"Example_ID\",\n \"label\": \"Example_String\",\n \"productId\": \"Example_String\",\n \"erpCode\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"isActive\": true,\n \"linkedProducts\": [\n {\n \"erpCode\": \"Example_String\",\n \"productId\": \"Example_String\",\n \"title\": \"Example_String\",\n \"label\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"imageUrls\": [\n \"https://exemplo.com\"\n ]\n }\n ]\n }\n }\n}"},{"id":"b854c9fc-58b7-4a34-a33c-eb9955c9c3af","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroup($input: ProductGroupInput!) {\n productGroup(input: $input) {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n}","variables":"{\n \"input\": {\n \"productId\": \"{{productId}}\",\n \"erpCode\": \"Example_String\",\n \"includeInvalidLinkedProducts\": \"https://exemplo.com\",\n \"includeSoldOutProducts\": true\n }\n}"}},"url":"{{base_url}}","description":"## productGroup\n\n**Propósito:** Busca o grupo de produtos vinculados ao produto informado, identificado por `productId` ou `erpCode`.\n**Quando usar:** Ao exibir um produto, para descobrir quais outros produtos do catálogo foram cadastrados como opções relacionadas a ele (ex.: variações vendidas como produtos separados) e montar um seletor ou lista de alternativas. Retorna `null` (não é erro) quando não existe grupo ativo para o produto informado.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\nÚnico argumento: `input: ProductGroupInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------------------ | --------- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `input.productId` | `String` | Condicional | — | ID do produto que representa o grupo. Envie exatamente um entre `productId` e `erpCode` (ver Notas). |\n| `input.erpCode` | `String` | Condicional | — | Código ERP do produto que representa o grupo. Envie exatamente um entre `productId` e `erpCode` (ver Notas). |\n| `input.includeInvalidLinkedProducts` | `Boolean` | Não | `false` | Inclui no retorno produtos vinculados cujo catálogo foi excluído ou que estão totalmente esgotados. Ver Notas para o comportamento combinado com `includeSoldOutProducts`. |\n| `input.includeSoldOutProducts` | `Boolean` | Não | `false` | Quando `includeInvalidLinkedProducts` não é enviado (comportamento padrão), controla se produtos vinculados totalmente esgotados (todas as variações esgotadas) entram (`true`) ou não (`false`) no retorno. |\n\n### Retorno\n\nUm `ProductGroup`, ou `null` se não existir grupo ativo para o `productId`/`erpCode` informado.\n\n| Propriedade | Tipo | Descrição |\n| ---------------------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do grupo. |\n| `label` | `String` | Nome do grupo, pensado para ser exibido ao comprador na hora de escolher entre as opções. |\n| `productId` | `String!` | ID do produto que representa/possui o grupo. |\n| `erpCode` | `String` | Código ERP do produto que representa o grupo, se cadastrado. |\n| `shopId` | `String!` | ID da sua loja — sempre preenchido no retorno, mesmo que você não envie `shopId` no argumento. |\n| `isActive` | `Boolean!` | Sempre `true` quando a operação retorna um grupo (grupos inativos fazem a operação retornar `null` em vez do objeto). |\n| `linkedProducts` | `[LinkedProduct]!` | Produtos vinculados ao grupo. Ver campos abaixo. |\n| `linkedProducts[].productId` | `String!` | ID do produto vinculado. |\n| `linkedProducts[].erpCode` | `String` | Código ERP do produto vinculado, se cadastrado. |\n| `linkedProducts[].title` | `String!` | Título do produto vinculado, congelado no momento em que o vínculo foi criado. |\n| `linkedProducts[].label` | `String` | Nome para exibição do produto vinculado dentro do grupo (pode diferir de `title`). |\n| `linkedProducts[].slug` | `String!` | Slug do produto vinculado, congelado no momento em que o vínculo foi criado. |\n| `linkedProducts[].imageUrls` | `[String]` | URLs das imagens do produto vinculado, obtidas do catálogo atual. |\n| `linkedProducts[].catalog` | `CatalogProduct` | Estado atual do produto vinculado no catálogo. `null` se o produto vinculado foi excluído do catálogo ou nunca existiu. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `input` enviado sem `productId` nem `erpCode`, ou com os dois ao mesmo tempo. | Erro de validação com mensagem descritiva. Envie exatamente um dos dois. |\n| _(sem código)_ | A loja da conta autenticada não pôde ser resolvida (`SHOP_NOT_FOUND_ERROR`). | Confirme que sua conta está associada a uma loja ativa e que o `access_token` é válido; se persistir, contate seu contato Unbox. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Estes erros chegam via `errors[].message` (texto descritivo) e não garantem um `extensions.code` estável — verifique sempre `message`. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n### Notas\n\n- **Envie exatamente um entre `productId` e `erpCode`.** Omitir os dois ou enviar os dois ao mesmo tempo é rejeitado na validação.\n- **Comportamento padrão (sem flags):** o grupo retorna apenas produtos vinculados cujo catálogo existe, não foi excluído e tem ao menos uma variação disponível (não totalmente esgotado).\n- **`includeInvalidLinkedProducts: true` desliga esse filtro por completo** — o grupo passa a retornar todos os produtos vinculados cadastrados, incluindo os com catálogo excluído ou totalmente esgotados. Nesse modo, `includeSoldOutProducts` não tem efeito adicional (o filtro de esgotado já está desligado).\n- **`linkedProducts[].catalog` é resolvido de forma independente dos filtros acima**, item a item. No comportamento padrão isso raramente aparece, pois produtos sem catálogo válido já são removidos de `linkedProducts` antes de chegar aí; mas com `includeInvalidLinkedProducts: true` você pode ver itens em `linkedProducts` cujo `catalog` vem `null` (produto removido do catálogo), mesmo com `title`/`slug` ainda preenchidos."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"b9f5ae1e-08d3-52a5-b65f-621d22511137"},{"name":"[Query] productGroups","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns productGroups data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"productGroups\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"productGroups returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.productGroups;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"f352b7aa-8eca-548e-ae50-2b23077bf781","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroups($filters: ProductGroupFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder) {\n productGroups(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder) {\n edges {\n cursor\n node {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n }\n }\n }\n nodes {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"isActive\": true,\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\"\n}"}},"url":"{{base_url}}","description":"productGroups
\nPropósito: Lista, com paginação, os grupos de produtos (ProductGroup) cadastrados na sua loja, com filtros por status e data de criação.\nQuando usar: Para obter em lote os grupos existentes — por exemplo, para sincronizar ou auditar quais produtos estão agrupados, sem precisar consultar produto a produto via productGroup.\nAutenticação: x-api-key + Authorization. A loja é resolvida diretamente pela sua conta autenticada; esta operação não expõe (nem aceita) um argumento de loja.
\nArgumentos
\nTodos os argumentos são opcionais e combináveis. Ver a seção Paginação Relay no folder deste domínio para os argumentos de paginação.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nProductGroupFilterInput | \nNão | \n— | \nFiltros da listagem. Ver campos abaixo. | \n
\n\nfilters.isActive | \nBoolean | \nNão | \ntrue | \nFiltra por grupos ativos (true) ou inativos (false). Se omitido, retorna apenas grupos ativos. | \n
\n\nfilters.createdAt | \nDateFilterInput | \nNão | \n— | \nFiltra por intervalo de data de criação do grupo: { gte: AWSDateTime, lte: AWSDateTime } (ambos opcionais). | \n
\n\nafter | \nString | \nNão | \n— | \nCursor de paginação — retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \n— | \nCursor de paginação — retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n20 | \nQuantidade máxima de resultados a retornar (1 a 50). Use com after ou offset. | \n
\n\nlast | \nInt | \nNão | \n20 | \nQuantidade máxima de resultados a retornar (1 a 50), a partir do fim. Use com before (não combine com offset). | \n
\n\noffset | \nInt | \nNão | \n0 | \nPula os N primeiros resultados. Use com first (não combine com last). | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nDireção da ordenação (asc/desc), pela ordem de criação dos grupos. | \n
\n\n
\n
Retorno
\nProductGroupConnection! — uma connection Relay (ver Paginação Relay no folder deste domínio), nunca null, mas pode retornar uma página vazia.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nedges[].cursor | \nString! | \nCursor do item, usado com after/before para paginar. | \n
\n\nedges[].node | \nProductGroup | \nO grupo em si (mesma forma retornada por productGroup). | \n
\n\nnodes | \n[ProductGroup] | \nAtalho com os grupos diretamente, sem o wrapper de cursor de edges. | \n
\n\npageInfo.hasNextPage | \nBoolean! | \nSe há mais resultados após a página atual. | \n
\n\npageInfo.hasPreviousPage | \nBoolean! | \nSe há resultados antes da página atual. | \n
\n\npageInfo.startCursor | \nString | \nCursor do primeiro item da página atual. | \n
\n\npageInfo.endCursor | \nString | \nCursor do último item da página atual. | \n
\n\ntotalCount | \nInt! | \nTotal de grupos que atendem aos filtros, independente da paginação. | \n
\n\n
\n
Cada ProductGroup em nodes/edges[].node segue os mesmos campos documentados na operação productGroup — exceto pelo comportamento de linkedProducts descrito em Notas.
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nArgumentos last e offset enviados juntos. | \nErro de validação com mensagem descritiva. Envie apenas um dos dois esquemas de paginação por chamada. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Erros de validação chegam via errors[].message (texto descritivo) e não garantem um extensions.code estável — verifique sempre message. Esta operação exige autenticação; falhas de autenticação (access_token ausente ou expirado) seguem o padrão geral descrito na Overview.
\n
\nNotas
\n\nlinkedProducts aqui não passa pelos filtros de productGroup. Esta operação não tem os argumentos includeInvalidLinkedProducts/includeSoldOutProducts — cada grupo listado retorna seus linkedProducts exatamente como cadastrados, incluindo produtos cujo catálogo foi excluído ou que estão totalmente esgotados. Use linkedProducts[].catalog (resolvido em tempo real por item) para checar validade do seu lado.linkedProducts[].imageUrls vem sempre vazio/null nesta operação. Diferente de productGroup, productGroups não enriquece os produtos vinculados com imagens do catálogo. Se precisar de imagem, use linkedProducts[].catalog.primaryImage/.media.filters.isActive tem default true. Para listar também grupos inativos, envie isActive: false explicitamente (não há opção de \"ambos\" — é uma chamada por status).
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9e011ff1-f2af-4979-bade-51aaa496e887","name":"200 - productGroups","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroups($filters: ProductGroupFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder) {\n productGroups(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder) {\n edges {\n cursor\n node {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n }\n }\n }\n nodes {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"isActive\": true,\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\"\n}"}},"url":"{{base_url}}","description":"## productGroups\n\n**Propósito:** Lista, com paginação, os grupos de produtos (`ProductGroup`) cadastrados na sua loja, com filtros por status e data de criação.\n**Quando usar:** Para obter em lote os grupos existentes — por exemplo, para sincronizar ou auditar quais produtos estão agrupados, sem precisar consultar produto a produto via `productGroup`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida diretamente pela sua conta autenticada; esta operação não expõe (nem aceita) um argumento de loja.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | ------------------------- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------ |\n| `filters` | `ProductGroupFilterInput` | Não | — | Filtros da listagem. Ver campos abaixo. |\n| `filters.isActive` | `Boolean` | Não | `true` | Filtra por grupos ativos (`true`) ou inativos (`false`). Se omitido, retorna apenas grupos ativos. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por intervalo de data de criação do grupo: `{ gte: AWSDateTime, lte: AWSDateTime }` (ambos opcionais). |\n| `after` | `String` | Não | — | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50). Use com `after` ou `offset`. |\n| `last` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50), a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | 0 | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`), pela ordem de criação dos grupos. |\n\n### Retorno\n\n`ProductGroupConnection!` — uma connection Relay (ver **Paginação Relay** no folder deste domínio), nunca `null`, mas pode retornar uma página vazia.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ---------------- | --------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductGroup` | O grupo em si (mesma forma retornada por `productGroup`). |\n| `nodes` | `[ProductGroup]` | Atalho com os grupos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de grupos que atendem aos filtros, independente da paginação. |\n\nCada `ProductGroup` em `nodes`/`edges[].node` segue os mesmos campos documentados na operação `productGroup` — exceto pelo comportamento de `linkedProducts` descrito em Notas.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação chegam via `errors[].message` (texto descritivo) e não garantem um `extensions.code` estável — verifique sempre `message`. Esta operação exige autenticação; falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n### Notas\n\n- **`linkedProducts` aqui não passa pelos filtros de `productGroup`.** Esta operação não tem os argumentos `includeInvalidLinkedProducts`/`includeSoldOutProducts` — cada grupo listado retorna seus `linkedProducts` exatamente como cadastrados, incluindo produtos cujo catálogo foi excluído ou que estão totalmente esgotados. Use `linkedProducts[].catalog` (resolvido em tempo real por item) para checar validade do seu lado.\n- **`linkedProducts[].imageUrls` vem sempre vazio/`null` nesta operação.** Diferente de `productGroup`, `productGroups` não enriquece os produtos vinculados com imagens do catálogo. Se precisar de imagem, use `linkedProducts[].catalog.primaryImage`/`.media`.\n- **`filters.isActive` tem default `true`.** Para listar também grupos inativos, envie `isActive: false` explicitamente (não há opção de \"ambos\" — é uma chamada por status)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"productGroups\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"label\": \"Example_String\",\n \"productId\": \"Example_String\",\n \"erpCode\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"isActive\": true\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"36957887-6dc8-47d2-a628-52e5a6e102c2","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroups($filters: ProductGroupFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder) {\n productGroups(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder) {\n edges {\n cursor\n node {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n }\n }\n }\n nodes {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"isActive\": true,\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\"\n}"}},"url":"{{base_url}}","description":"## productGroups\n\n**Propósito:** Lista, com paginação, os grupos de produtos (`ProductGroup`) cadastrados na sua loja, com filtros por status e data de criação.\n**Quando usar:** Para obter em lote os grupos existentes — por exemplo, para sincronizar ou auditar quais produtos estão agrupados, sem precisar consultar produto a produto via `productGroup`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida diretamente pela sua conta autenticada; esta operação não expõe (nem aceita) um argumento de loja.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | ------------------------- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------ |\n| `filters` | `ProductGroupFilterInput` | Não | — | Filtros da listagem. Ver campos abaixo. |\n| `filters.isActive` | `Boolean` | Não | `true` | Filtra por grupos ativos (`true`) ou inativos (`false`). Se omitido, retorna apenas grupos ativos. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por intervalo de data de criação do grupo: `{ gte: AWSDateTime, lte: AWSDateTime }` (ambos opcionais). |\n| `after` | `String` | Não | — | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50). Use com `after` ou `offset`. |\n| `last` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50), a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | 0 | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`), pela ordem de criação dos grupos. |\n\n### Retorno\n\n`ProductGroupConnection!` — uma connection Relay (ver **Paginação Relay** no folder deste domínio), nunca `null`, mas pode retornar uma página vazia.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ---------------- | --------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductGroup` | O grupo em si (mesma forma retornada por `productGroup`). |\n| `nodes` | `[ProductGroup]` | Atalho com os grupos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de grupos que atendem aos filtros, independente da paginação. |\n\nCada `ProductGroup` em `nodes`/`edges[].node` segue os mesmos campos documentados na operação `productGroup` — exceto pelo comportamento de `linkedProducts` descrito em Notas.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação chegam via `errors[].message` (texto descritivo) e não garantem um `extensions.code` estável — verifique sempre `message`. Esta operação exige autenticação; falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n### Notas\n\n- **`linkedProducts` aqui não passa pelos filtros de `productGroup`.** Esta operação não tem os argumentos `includeInvalidLinkedProducts`/`includeSoldOutProducts` — cada grupo listado retorna seus `linkedProducts` exatamente como cadastrados, incluindo produtos cujo catálogo foi excluído ou que estão totalmente esgotados. Use `linkedProducts[].catalog` (resolvido em tempo real por item) para checar validade do seu lado.\n- **`linkedProducts[].imageUrls` vem sempre vazio/`null` nesta operação.** Diferente de `productGroup`, `productGroups` não enriquece os produtos vinculados com imagens do catálogo. Se precisar de imagem, use `linkedProducts[].catalog.primaryImage`/`.media`.\n- **`filters.isActive` tem default `true`.** Para listar também grupos inativos, envie `isActive: false` explicitamente (não há opção de \"ambos\" — é uma chamada por status)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"7f0ddc9f-8260-4c2c-9c57-b68ffe6e746d","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductGroups($filters: ProductGroupFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder) {\n productGroups(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder) {\n edges {\n cursor\n node {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n }\n }\n }\n nodes {\n _id\n label\n productId\n erpCode\n shopId\n isActive\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n catalog {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"isActive\": true,\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\"\n}"}},"url":"{{base_url}}","description":"## productGroups\n\n**Propósito:** Lista, com paginação, os grupos de produtos (`ProductGroup`) cadastrados na sua loja, com filtros por status e data de criação.\n**Quando usar:** Para obter em lote os grupos existentes — por exemplo, para sincronizar ou auditar quais produtos estão agrupados, sem precisar consultar produto a produto via `productGroup`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida diretamente pela sua conta autenticada; esta operação não expõe (nem aceita) um argumento de loja.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | ------------------------- | ----------- | ------- | ------------------------------------------------------------------------------------------------------------------ |\n| `filters` | `ProductGroupFilterInput` | Não | — | Filtros da listagem. Ver campos abaixo. |\n| `filters.isActive` | `Boolean` | Não | `true` | Filtra por grupos ativos (`true`) ou inativos (`false`). Se omitido, retorna apenas grupos ativos. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por intervalo de data de criação do grupo: `{ gte: AWSDateTime, lte: AWSDateTime }` (ambos opcionais). |\n| `after` | `String` | Não | — | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50). Use com `after` ou `offset`. |\n| `last` | `Int` | Não | 20 | Quantidade máxima de resultados a retornar (1 a 50), a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | 0 | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`), pela ordem de criação dos grupos. |\n\n### Retorno\n\n`ProductGroupConnection!` — uma connection Relay (ver **Paginação Relay** no folder deste domínio), nunca `null`, mas pode retornar uma página vazia.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ---------------- | --------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductGroup` | O grupo em si (mesma forma retornada por `productGroup`). |\n| `nodes` | `[ProductGroup]` | Atalho com os grupos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de grupos que atendem aos filtros, independente da paginação. |\n\nCada `ProductGroup` em `nodes`/`edges[].node` segue os mesmos campos documentados na operação `productGroup` — exceto pelo comportamento de `linkedProducts` descrito em Notas.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------ |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Erros de validação chegam via `errors[].message` (texto descritivo) e não garantem um `extensions.code` estável — verifique sempre `message`. Esta operação exige autenticação; falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n### Notas\n\n- **`linkedProducts` aqui não passa pelos filtros de `productGroup`.** Esta operação não tem os argumentos `includeInvalidLinkedProducts`/`includeSoldOutProducts` — cada grupo listado retorna seus `linkedProducts` exatamente como cadastrados, incluindo produtos cujo catálogo foi excluído ou que estão totalmente esgotados. Use `linkedProducts[].catalog` (resolvido em tempo real por item) para checar validade do seu lado.\n- **`linkedProducts[].imageUrls` vem sempre vazio/`null` nesta operação.** Diferente de `productGroup`, `productGroups` não enriquece os produtos vinculados com imagens do catálogo. Se precisar de imagem, use `linkedProducts[].catalog.primaryImage`/`.media`.\n- **`filters.isActive` tem default `true`.** Para listar também grupos inativos, envie `isActive: false` explicitamente (não há opção de \"ambos\" — é uma chamada por status)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"f352b7aa-8eca-548e-ae50-2b23077bf781"},{"name":"[Query] catalogItems","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns catalogItems data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"catalogItems\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"catalogItems returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.catalogItems;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"1a11011f-f778-53b1-9d88-a2ef0c2a9be8","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItems($tagIds: [ID], $booleanFilters: [CatalogBooleanFilter], $productIdsOrERPCodes: [String], $priceRange: CatalogPriceRangeFilter, $searchText: String, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortByPriceCurrencyCode: String, $sortBy: CatalogItemSortByField) {\n catalogItems(tagIds: $tagIds, booleanFilters: $booleanFilters, productIdsOrERPCodes: $productIdsOrERPCodes, priceRange: $priceRange, searchText: $searchText, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortByPriceCurrencyCode: $sortByPriceCurrencyCode, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n }\n nodes {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"productIdsOrERPCodes\": [\n \"Example_String\"\n ],\n \"priceRange\": {\n \"gte\": 99.99,\n \"lte\": 99.99\n },\n \"searchText\": \"Example_String\",\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 10,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortByPriceCurrencyCode\": 99.99,\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"catalogItems
\nPropósito: Lista, com paginação, os itens do catálogo publicado da sua loja — a visão de catálogo (título, slug, mídia, variantes, descrições e labels de kit/preço unitário), com filtros por tag, faixa de preço, texto e IDs/ERP codes.\nQuando usar: Para montar ou sincronizar a vitrine do seu canal a partir do catálogo publicado (não da visão administrativa do produto). Para um único produto já conhecido pelo slug, prefira catalogItemProductBySlug; para a visão administrativa (estado de publicação, tags, sitemap), use products.\nAutenticação: x-api-key + Authorization. Os resultados são sempre escopados à loja da conta autenticada — o identificador da loja é derivado do seu token na borda, não há argumento de loja nesta operação e você não o envia. Envie sempre um Authorization válido: sem ele o escopo de loja não é aplicado e a chamada falha.
\nArgumentos
\nTodos os argumentos são opcionais e combináveis. Ver a seção Paginação Relay no folder deste domínio para os argumentos de paginação.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ntagIds | \n[ID] | \nNão | \nnull (sem filtro) | \nLista de IDs de tag para restringir os itens àqueles associados a qualquer uma delas. | \n
\n\nbooleanFilters | \n[CatalogBooleanFilter] | \nNão | \nnull | \nFiltros booleanos adicionais aplicados ao catálogo. | \n
\n\nproductIdsOrERPCodes | \n[String] | \nNão | \nnull | \nRestringe o resultado a produtos com estes IDs de produto ou códigos de ERP. | \n
\n\npriceRange | \nCatalogPriceRangeFilter | \nNão | \nnull | \nFiltra por uma faixa de preço. A moeda considerada é a de sortByPriceCurrencyCode (default BRL). | \n
\n\nsearchText | \nString | \nNão | \nnull | \nBusca textual sobre título e descrição dos itens do catálogo. | \n
\n\nafter | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar. Use com after ou offset. | \n
\n\nlast | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar, a partir do fim. Use com before (não combine com offset). | \n
\n\noffset | \nInt | \nNão | \nnull | \nPula os N primeiros resultados. Use com first (não combine com last). | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nDireção da ordenação (asc/desc). | \n
\n\nsortBy | \nCatalogItemSortByField | \nNão | \nupdatedAt | \nCampo de ordenação: _id, createdAt, minPrice, sortIndex, title, updatedAt. Ao ordenar por minPrice, informe sortByPriceCurrencyCode. | \n
\n\nsortByPriceCurrencyCode | \nString | \nNão | \nBRL | \nCódigo de moeda usado ao ordenar por minPrice e ao aplicar priceRange. Sem este valor, os preços são avaliados em BRL — informe a moeda correta para catálogos não-BRL. | \n
\n\n
\n
Retorno
\nCatalogItemConnection — uma connection Relay (ver Paginação Relay no folder deste domínio). nodes/edges[].node são do tipo interface CatalogItem, que expõe diretamente apenas _id, createdAt, shop e updatedAt. Para ler os campos do item de produto (publishedUrl, product, etc.), use um inline fragment ... on CatalogItemProduct { ... } e inclua __typename na seleção — a API exige o __typename para resolver o tipo concreto da interface; sem ele a consulta falha com \"Abstract type 'CatalogItem' must resolve to an Object type\". Ex.: nodes { __typename ... on CatalogItemProduct { product { title slug } } }.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nedges[].cursor | \nString! | \nCursor do item, usado com after/before para paginar. | \n
\n\nedges[].node / nodes[] | \nCatalogItem | \nItem de catálogo (interface). Campos diretos: _id, createdAt, shop, updatedAt. | \n
\n\n... on CatalogItemProduct { publishedUrl } | \nString | \nURL publicada do item no storefront. | \n
\n\n... on CatalogItemProduct { cardDescription } | \nString | \nDescrição curta para card/listagem. | \n
\n\n... on CatalogItemProduct { shortDescription } | \nString | \nDescrição resumida do item. | \n
\n\n... on CatalogItemProduct { product } | \nCatalogProduct | \nConteúdo do produto publicado: title, slug, sku, media, variants, descrições, grupos/kit e labels (unitPriceLabel, unitPriceFactor). | \n
\n\npageInfo.hasNextPage / hasPreviousPage | \nBoolean! | \nSe há mais resultados após / antes da página atual. | \n
\n\npageInfo.startCursor / endCursor | \nString | \nCursores do primeiro e do último item da página atual. | \n
\n\ntotalCount | \nInt! | \nTotal de itens que atendem aos filtros, independente da paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nAuthorization ausente ou inválido. | \nSem um token válido o escopo de loja não é derivado e a chamada falha. Refaça signIn e reenvie. | \n
\n\n| (sem código) | \nArgumentos last e offset enviados juntos. | \nErro de validação com mensagem descritiva, sem extensions.code estável. Envie apenas um dos dois esquemas de paginação por chamada. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio.
\n
\nNotas
\n\n- A consulta é autenticada como a própria loja, então retorna o catálogo da sua loja — o que pode incluir itens ocultos/não-publicados (
isVisible: false); itens excluídos nunca aparecem. Use booleanFilters para restringir o conjunto ao seu caso de uso (ex.: montar uma vitrine só com itens visíveis). \n- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (
unitPriceLabel, unitPriceFactor) no CatalogProduct. priceRange/minPrice operam sobre o preço interno do catálogo (na moeda de sortByPriceCurrencyCode), mas o valor numérico em si não é retornado no payload. \n- Sem filtros, retorna todo o catálogo elegível da loja, sujeito à paginação — em catálogos grandes, sempre pagine.
\n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"91739e65-44fe-4934-a8b2-c6e649462180","name":"200 - catalogItems","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItems($tagIds: [ID], $booleanFilters: [CatalogBooleanFilter], $productIdsOrERPCodes: [String], $priceRange: CatalogPriceRangeFilter, $searchText: String, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortByPriceCurrencyCode: String, $sortBy: CatalogItemSortByField) {\n catalogItems(tagIds: $tagIds, booleanFilters: $booleanFilters, productIdsOrERPCodes: $productIdsOrERPCodes, priceRange: $priceRange, searchText: $searchText, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortByPriceCurrencyCode: $sortByPriceCurrencyCode, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n }\n nodes {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"productIdsOrERPCodes\": [\n \"Example_String\"\n ],\n \"priceRange\": {\n \"gte\": 99.99,\n \"lte\": 99.99\n },\n \"searchText\": \"Example_String\",\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 10,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortByPriceCurrencyCode\": 99.99,\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## catalogItems\n\n**Propósito:** Lista, com paginação, os itens do catálogo publicado da sua loja — a visão de catálogo (título, slug, mídia, variantes, descrições e labels de kit/preço unitário), com filtros por tag, faixa de preço, texto e IDs/ERP codes.\n**Quando usar:** Para montar ou sincronizar a vitrine do seu canal a partir do catálogo publicado (não da visão administrativa do produto). Para um único produto já conhecido pelo slug, prefira `catalogItemProductBySlug`; para a visão administrativa (estado de publicação, tags, sitemap), use `products`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada — o identificador da loja é derivado do seu token na borda, **não há argumento de loja nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------- | ------------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tagIds` | `[ID]` | Não | `null` (sem filtro) | Lista de IDs de tag para restringir os itens àqueles associados a qualquer uma delas. |\n| `booleanFilters` | `[CatalogBooleanFilter]` | Não | `null` | Filtros booleanos adicionais aplicados ao catálogo. |\n| `productIdsOrERPCodes` | `[String]` | Não | `null` | Restringe o resultado a produtos com estes IDs de produto ou códigos de ERP. |\n| `priceRange` | `CatalogPriceRangeFilter` | Não | `null` | Filtra por uma faixa de preço. A moeda considerada é a de `sortByPriceCurrencyCode` (default `BRL`). |\n| `searchText` | `String` | Não | `null` | Busca textual sobre título e descrição dos itens do catálogo. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `CatalogItemSortByField` | Não | `updatedAt` | Campo de ordenação: `_id`, `createdAt`, `minPrice`, `sortIndex`, `title`, `updatedAt`. Ao ordenar por `minPrice`, informe `sortByPriceCurrencyCode`. |\n| `sortByPriceCurrencyCode` | `String` | Não | `BRL` | Código de moeda usado ao ordenar por `minPrice` **e** ao aplicar `priceRange`. Sem este valor, os preços são avaliados em `BRL` — informe a moeda correta para catálogos não-BRL. |\n\n### Retorno\n\n`CatalogItemConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). `nodes`/`edges[].node` são do tipo **interface `CatalogItem`**, que expõe diretamente apenas `_id`, `createdAt`, `shop` e `updatedAt`. Para ler os campos do item de produto (`publishedUrl`, `product`, etc.), use um inline fragment `... on CatalogItemProduct { ... }` **e inclua `__typename` na seleção** — a API exige o `__typename` para resolver o tipo concreto da interface; sem ele a consulta falha com _\"Abstract type 'CatalogItem' must resolve to an Object type\"_. Ex.: `nodes { __typename ... on CatalogItemProduct { product { title slug } } }`.\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` / `nodes[]` | `CatalogItem` | Item de catálogo (interface). Campos diretos: `_id`, `createdAt`, `shop`, `updatedAt`. |\n| `... on CatalogItemProduct { publishedUrl }` | `String` | URL publicada do item no storefront. |\n| `... on CatalogItemProduct { cardDescription }` | `String` | Descrição curta para card/listagem. |\n| `... on CatalogItemProduct { shortDescription }` | `String` | Descrição resumida do item. |\n| `... on CatalogItemProduct { product } ` | `CatalogProduct` | Conteúdo do produto publicado: `title`, `slug`, `sku`, `media`, `variants`, descrições, grupos/kit e labels (`unitPriceLabel`, `unitPriceFactor`). |\n| `pageInfo.hasNextPage` / `hasPreviousPage` | `Boolean!` | Se há mais resultados após / antes da página atual. |\n| `pageInfo.startCursor` / `endCursor` | `String` | Cursores do primeiro e do último item da página atual. |\n| `totalCount` | `Int!` | Total de itens que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- A consulta é autenticada como a própria loja, então retorna o catálogo **da sua loja** — o que pode incluir itens ocultos/não-publicados (`isVisible: false`); itens excluídos nunca aparecem. Use `booleanFilters` para restringir o conjunto ao seu caso de uso (ex.: montar uma vitrine só com itens visíveis).\n- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (`unitPriceLabel`, `unitPriceFactor`) no `CatalogProduct`. `priceRange`/`minPrice` operam sobre o preço interno do catálogo (na moeda de `sortByPriceCurrencyCode`), mas o valor numérico em si não é retornado no payload.\n- Sem filtros, retorna todo o catálogo elegível da loja, sujeito à paginação — em catálogos grandes, sempre pagine."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"catalogItems\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"580698cb-6757-403a-a3bb-8d79b6e36fde","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItems($tagIds: [ID], $booleanFilters: [CatalogBooleanFilter], $productIdsOrERPCodes: [String], $priceRange: CatalogPriceRangeFilter, $searchText: String, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortByPriceCurrencyCode: String, $sortBy: CatalogItemSortByField) {\n catalogItems(tagIds: $tagIds, booleanFilters: $booleanFilters, productIdsOrERPCodes: $productIdsOrERPCodes, priceRange: $priceRange, searchText: $searchText, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortByPriceCurrencyCode: $sortByPriceCurrencyCode, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n }\n nodes {\n _id\n createdAt\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"productIdsOrERPCodes\": [\n \"Example_String\"\n ],\n \"priceRange\": {\n \"gte\": 99.99,\n \"lte\": 99.99\n },\n \"searchText\": \"Example_String\",\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 10,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortByPriceCurrencyCode\": 99.99,\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## catalogItems\n\n**Propósito:** Lista, com paginação, os itens do catálogo publicado da sua loja — a visão de catálogo (título, slug, mídia, variantes, descrições e labels de kit/preço unitário), com filtros por tag, faixa de preço, texto e IDs/ERP codes.\n**Quando usar:** Para montar ou sincronizar a vitrine do seu canal a partir do catálogo publicado (não da visão administrativa do produto). Para um único produto já conhecido pelo slug, prefira `catalogItemProductBySlug`; para a visão administrativa (estado de publicação, tags, sitemap), use `products`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada — o identificador da loja é derivado do seu token na borda, **não há argumento de loja nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------- | ------------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tagIds` | `[ID]` | Não | `null` (sem filtro) | Lista de IDs de tag para restringir os itens àqueles associados a qualquer uma delas. |\n| `booleanFilters` | `[CatalogBooleanFilter]` | Não | `null` | Filtros booleanos adicionais aplicados ao catálogo. |\n| `productIdsOrERPCodes` | `[String]` | Não | `null` | Restringe o resultado a produtos com estes IDs de produto ou códigos de ERP. |\n| `priceRange` | `CatalogPriceRangeFilter` | Não | `null` | Filtra por uma faixa de preço. A moeda considerada é a de `sortByPriceCurrencyCode` (default `BRL`). |\n| `searchText` | `String` | Não | `null` | Busca textual sobre título e descrição dos itens do catálogo. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `CatalogItemSortByField` | Não | `updatedAt` | Campo de ordenação: `_id`, `createdAt`, `minPrice`, `sortIndex`, `title`, `updatedAt`. Ao ordenar por `minPrice`, informe `sortByPriceCurrencyCode`. |\n| `sortByPriceCurrencyCode` | `String` | Não | `BRL` | Código de moeda usado ao ordenar por `minPrice` **e** ao aplicar `priceRange`. Sem este valor, os preços são avaliados em `BRL` — informe a moeda correta para catálogos não-BRL. |\n\n### Retorno\n\n`CatalogItemConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). `nodes`/`edges[].node` são do tipo **interface `CatalogItem`**, que expõe diretamente apenas `_id`, `createdAt`, `shop` e `updatedAt`. Para ler os campos do item de produto (`publishedUrl`, `product`, etc.), use um inline fragment `... on CatalogItemProduct { ... }` **e inclua `__typename` na seleção** — a API exige o `__typename` para resolver o tipo concreto da interface; sem ele a consulta falha com _\"Abstract type 'CatalogItem' must resolve to an Object type\"_. Ex.: `nodes { __typename ... on CatalogItemProduct { product { title slug } } }`.\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` / `nodes[]` | `CatalogItem` | Item de catálogo (interface). Campos diretos: `_id`, `createdAt`, `shop`, `updatedAt`. |\n| `... on CatalogItemProduct { publishedUrl }` | `String` | URL publicada do item no storefront. |\n| `... on CatalogItemProduct { cardDescription }` | `String` | Descrição curta para card/listagem. |\n| `... on CatalogItemProduct { shortDescription }` | `String` | Descrição resumida do item. |\n| `... on CatalogItemProduct { product } ` | `CatalogProduct` | Conteúdo do produto publicado: `title`, `slug`, `sku`, `media`, `variants`, descrições, grupos/kit e labels (`unitPriceLabel`, `unitPriceFactor`). |\n| `pageInfo.hasNextPage` / `hasPreviousPage` | `Boolean!` | Se há mais resultados após / antes da página atual. |\n| `pageInfo.startCursor` / `endCursor` | `String` | Cursores do primeiro e do último item da página atual. |\n| `totalCount` | `Int!` | Total de itens que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- A consulta é autenticada como a própria loja, então retorna o catálogo **da sua loja** — o que pode incluir itens ocultos/não-publicados (`isVisible: false`); itens excluídos nunca aparecem. Use `booleanFilters` para restringir o conjunto ao seu caso de uso (ex.: montar uma vitrine só com itens visíveis).\n- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (`unitPriceLabel`, `unitPriceFactor`) no `CatalogProduct`. `priceRange`/`minPrice` operam sobre o preço interno do catálogo (na moeda de `sortByPriceCurrencyCode`), mas o valor numérico em si não é retornado no payload.\n- Sem filtros, retorna todo o catálogo elegível da loja, sujeito à paginação — em catálogos grandes, sempre pagine."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"1a11011f-f778-53b1-9d88-a2ef0c2a9be8"},{"name":"[Query] catalogItemProductBySlug","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns catalogItemProductBySlug data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"catalogItemProductBySlug\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"catalogItemProductBySlug returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.catalogItemProductBySlug;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.publishedUrl !== undefined && data.publishedUrl !== null) {"," pm.expect(typeof data.publishedUrl).to.equal(\"string\");"," }"," if (data.shortDescription !== undefined && data.shortDescription !== null) {"," pm.expect(typeof data.shortDescription).to.equal(\"string\");"," }"," if (data.cardDescription !== undefined && data.cardDescription !== null) {"," pm.expect(typeof data.cardDescription).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.product !== undefined && data.product !== null) {"," pm.expect(data.product).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"shop\");"," if (data.shop !== undefined && data.shop !== null) {"," pm.expect(data.shop).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"updatedAt\");"," if (data.updatedAt !== undefined && data.updatedAt !== null) {"," pm.expect(typeof data.updatedAt).to.equal(\"string\");"," }"," if (data.updatedAt) {"," pm.expect(new Date(data.updatedAt).toString()).to.not.equal(\"Invalid Date\");"," }"," }","});"]}}],"id":"597d9c53-346c-52a6-a45d-74e1569de66b","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItemProductBySlug($productSlug: String!, $booleanFilters: [CatalogBooleanFilter], $filterSoldOutVariants: Boolean) {\n catalogItemProductBySlug(productSlug: $productSlug, booleanFilters: $booleanFilters, filterSoldOutVariants: $filterSoldOutVariants) {\n _id\n publishedUrl\n shortDescription\n cardDescription\n createdAt\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n}","variables":"{\n \"productSlug\": \"Example_String\",\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"filterSoldOutVariants\": true\n}"}},"url":"{{base_url}}","description":"catalogItemProductBySlug
\nPropósito: Retorna um único produto do catálogo publicado da sua loja a partir do seu slug — a visão de catálogo do produto (título, mídia, variantes, descrições e labels), para renderizar a página de produto (PDP) do seu storefront.\nQuando usar: Para montar a PDP a partir do slug presente na URL. Para listar/filtrar vários itens, use catalogItems; para a visão administrativa do produto, use product/products.\nAutenticação: x-api-key + Authorization. O produto é sempre buscado dentro da loja da conta autenticada — o identificador da loja é derivado do seu token na borda, não há argumento de loja nesta operação e você não o envia. Envie sempre um Authorization válido: sem ele o escopo de loja não é aplicado e a chamada falha.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nproductSlug | \nString! | \nSim | \n— | \nSlug do produto no catálogo (o mesmo usado na URL do storefront). | \n
\n\nbooleanFilters | \n[CatalogBooleanFilter] | \nNão | \nnull | \nFiltros booleanos adicionais aplicados ao item. | \n
\n\nfilterSoldOutVariants | \nBoolean | \nNão | \nfalse | \nQuando true, remove do resultado as variantes que não podem ser vendidas (esgotadas). | \n
\n\n
\n
Retorno
\nCatalogItemProduct — o item de catálogo do tipo produto. Retorna null quando nenhum produto publicado e visível corresponde ao slug na loja.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nIdentificador do item de catálogo. | \n
\n\npublishedUrl | \nString | \nURL publicada do produto no storefront. | \n
\n\ncardDescription | \nString | \nDescrição curta para card/listagem. | \n
\n\nshortDescription | \nString | \nDescrição resumida do item. | \n
\n\nproduct | \nCatalogProduct | \nConteúdo do produto publicado: title, slug, sku, media, variants, descrições, grupos/kit e labels (unitPriceLabel, unitPriceFactor). | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \nA loja da conta autenticada está inativa. | \nA loja precisa estar ativa para servir o catálogo. Verifique o status da conta. | \n
\n\n| (sem código) | \nAuthorization ausente ou inválido. | \nSem um token válido o escopo de loja não é derivado e a chamada falha. Refaça signIn e reenvie. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio. Slug inexistente não é erro: retorna data.catalogItemProductBySlug = null.
\n
\nNotas
\n\n- Diferente de
catalogItems, esta operação sempre exige que o item seja visível e publicado: um produto oculto (isVisible: false), não publicado ou com slug inexistente resulta em null. \nfilterSoldOutVariants: true é útil para PDPs que não devem exibir variantes esgotadas.- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (
unitPriceLabel, unitPriceFactor) no CatalogProduct. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4f0976fd-674d-4a71-bcf8-6d9c1b34227f","name":"200 - catalogItemProductBySlug","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItemProductBySlug($productSlug: String!, $booleanFilters: [CatalogBooleanFilter], $filterSoldOutVariants: Boolean) {\n catalogItemProductBySlug(productSlug: $productSlug, booleanFilters: $booleanFilters, filterSoldOutVariants: $filterSoldOutVariants) {\n _id\n publishedUrl\n shortDescription\n cardDescription\n createdAt\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n}","variables":"{\n \"productSlug\": \"Example_String\",\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"filterSoldOutVariants\": true\n}"}},"url":"{{base_url}}","description":"## catalogItemProductBySlug\n\n**Propósito:** Retorna um único produto do catálogo publicado da sua loja a partir do seu `slug` — a visão de catálogo do produto (título, mídia, variantes, descrições e labels), para renderizar a página de produto (PDP) do seu storefront.\n**Quando usar:** Para montar a PDP a partir do slug presente na URL. Para listar/filtrar vários itens, use `catalogItems`; para a visão administrativa do produto, use `product`/`products`.\n**Autenticação:** `x-api-key` + `Authorization`. O produto é sempre buscado dentro da loja da conta autenticada — o identificador da loja é derivado do seu token na borda, **não há argumento de loja nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------- | ------------------------ | ----------- | ------- | --------------------------------------------------------------------------------------- |\n| `productSlug` | `String!` | Sim | — | Slug do produto no catálogo (o mesmo usado na URL do storefront). |\n| `booleanFilters` | `[CatalogBooleanFilter]` | Não | `null` | Filtros booleanos adicionais aplicados ao item. |\n| `filterSoldOutVariants` | `Boolean` | Não | `false` | Quando `true`, remove do resultado as variantes que não podem ser vendidas (esgotadas). |\n\n### Retorno\n\n`CatalogItemProduct` — o item de catálogo do tipo produto. Retorna `null` quando nenhum produto publicado e visível corresponde ao `slug` na loja.\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do item de catálogo. |\n| `publishedUrl` | `String` | URL publicada do produto no storefront. |\n| `cardDescription` | `String` | Descrição curta para card/listagem. |\n| `shortDescription` | `String` | Descrição resumida do item. |\n| `product` | `CatalogProduct` | Conteúdo do produto publicado: `title`, `slug`, `sku`, `media`, `variants`, descrições, grupos/kit e labels (`unitPriceLabel`, `unitPriceFactor`). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | A loja da conta autenticada está inativa. | A loja precisa estar ativa para servir o catálogo. Verifique o status da conta. |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Slug inexistente **não** é erro: retorna `data.catalogItemProductBySlug = null`.\n\n### Notas\n\n- Diferente de `catalogItems`, esta operação sempre exige que o item seja **visível e publicado**: um produto oculto (`isVisible: false`), não publicado ou com slug inexistente resulta em `null`.\n- `filterSoldOutVariants: true` é útil para PDPs que não devem exibir variantes esgotadas.\n- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (`unitPriceLabel`, `unitPriceFactor`) no `CatalogProduct`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"catalogItemProductBySlug\": {\n \"_id\": \"Example_ID\",\n \"publishedUrl\": \"https://exemplo.com\",\n \"shortDescription\": \"Example_String\",\n \"cardDescription\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"product\": {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"barcode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"description\": \"Example_String\",\n \"height\": 99.99,\n \"isDeleted\": true,\n \"isVisible\": true,\n \"length\": 99.99,\n \"metaDescription\": \"Example_String\",\n \"minOrderQuantity\": 10,\n \"maxOrderQuantity\": 10,\n \"originCountry\": \"Example_String\",\n \"pageTitle\": \"Example_String\",\n \"productId\": \"Example_ID\",\n \"type\": \"PRODUCT_SIMPLE\",\n \"productType\": \"SIMPLE\",\n \"recurrenceAllowed\": true,\n \"sku\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"supportedFulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"vendor\": \"Example_String\",\n \"sortIndex\": 10,\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"weight\": 99.99,\n \"width\": 99.99,\n \"additionalInformation\": \"Example_String\",\n \"measurementsInformation\": \"Example_String\",\n \"requiredPicksPerGroup\": 10,\n \"unitPriceLabel\": 99.99,\n \"titleLabel\": \"Example_String\",\n \"highlightLabel\": \"Example_String\",\n \"kitGroupDescription\": \"Example_String\",\n \"unitPriceFactor\": 99.99,\n \"isBackorder\": true,\n \"isLowQuantity\": true,\n \"isSoldOut\": true,\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"imageUrls\": [\n \"https://exemplo.com\"\n ]\n },\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n }\n}"},{"id":"b854408e-dacd-46c3-9c48-6d7b4c02471d","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query CatalogItemProductBySlug($productSlug: String!, $booleanFilters: [CatalogBooleanFilter], $filterSoldOutVariants: Boolean) {\n catalogItemProductBySlug(productSlug: $productSlug, booleanFilters: $booleanFilters, filterSoldOutVariants: $filterSoldOutVariants) {\n _id\n publishedUrl\n shortDescription\n cardDescription\n createdAt\n product {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n maxCompareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n updatedAt\n }\n}","variables":"{\n \"productSlug\": \"Example_String\",\n \"booleanFilters\": [\n {\n \"name\": \"isDeleted\",\n \"value\": 99.99,\n \"onVariants\": true\n }\n ],\n \"filterSoldOutVariants\": true\n}"}},"url":"{{base_url}}","description":"## catalogItemProductBySlug\n\n**Propósito:** Retorna um único produto do catálogo publicado da sua loja a partir do seu `slug` — a visão de catálogo do produto (título, mídia, variantes, descrições e labels), para renderizar a página de produto (PDP) do seu storefront.\n**Quando usar:** Para montar a PDP a partir do slug presente na URL. Para listar/filtrar vários itens, use `catalogItems`; para a visão administrativa do produto, use `product`/`products`.\n**Autenticação:** `x-api-key` + `Authorization`. O produto é sempre buscado dentro da loja da conta autenticada — o identificador da loja é derivado do seu token na borda, **não há argumento de loja nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------- | ------------------------ | ----------- | ------- | --------------------------------------------------------------------------------------- |\n| `productSlug` | `String!` | Sim | — | Slug do produto no catálogo (o mesmo usado na URL do storefront). |\n| `booleanFilters` | `[CatalogBooleanFilter]` | Não | `null` | Filtros booleanos adicionais aplicados ao item. |\n| `filterSoldOutVariants` | `Boolean` | Não | `false` | Quando `true`, remove do resultado as variantes que não podem ser vendidas (esgotadas). |\n\n### Retorno\n\n`CatalogItemProduct` — o item de catálogo do tipo produto. Retorna `null` quando nenhum produto publicado e visível corresponde ao `slug` na loja.\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | Identificador do item de catálogo. |\n| `publishedUrl` | `String` | URL publicada do produto no storefront. |\n| `cardDescription` | `String` | Descrição curta para card/listagem. |\n| `shortDescription` | `String` | Descrição resumida do item. |\n| `product` | `CatalogProduct` | Conteúdo do produto publicado: `title`, `slug`, `sku`, `media`, `variants`, descrições, grupos/kit e labels (`unitPriceLabel`, `unitPriceFactor`). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | A loja da conta autenticada está inativa. | A loja precisa estar ativa para servir o catálogo. Verifique o status da conta. |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Slug inexistente **não** é erro: retorna `data.catalogItemProductBySlug = null`.\n\n### Notas\n\n- Diferente de `catalogItems`, esta operação sempre exige que o item seja **visível e publicado**: um produto oculto (`isVisible: false`), não publicado ou com slug inexistente resulta em `null`.\n- `filterSoldOutVariants: true` é útil para PDPs que não devem exibir variantes esgotadas.\n- O catálogo não expõe um campo de preço numérico calculado nesta versão — há apenas labels (`unitPriceLabel`, `unitPriceFactor`) no `CatalogProduct`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"597d9c53-346c-52a6-a45d-74e1569de66b"}],"id":"45356b2b-4291-49e3-a2e6-fd1909f31955","_postman_id":"45356b2b-4291-49e3-a2e6-fd1909f31955","description":""}],"id":"f50ccc4d-8883-4c9d-bfc6-3a1c06b5366c","description":"Catálogo e Grupos de Produtos
\nOperações somente leitura sobre o catálogo publicado da loja e como seus produtos são agrupados. catalogItems lista os itens do catálogo publicado (com filtros e paginação) e catalogItemProductBySlug busca um item de produto por slug — a visão de vitrine (título, mídia, variantes, descrições, labels). productGroup/productGroups consultam como produtos são agrupados como opções relacionadas de um mesmo item — por exemplo, variações cadastradas como produtos separados, mas exibidas juntas para o comprador escolher entre elas: productGroup busca o grupo de um produto específico; productGroups lista todos os grupos cadastrados na loja.
\nEm todas as operações deste domínio a loja é resolvida a partir da sua conta autenticada — você não envia nenhum argumento de loja.
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores/Campos | \nDescrição | \n
\n\n\n\nSortOrder | \nasc, desc | \nDireção de ordenação usada em productGroups. Se omitido, o padrão é desc. | \n
\n\nLinkedProduct | \nproductId, erpCode, title, label, slug, imageUrls, catalog | \nUm produto vinculado dentro de um grupo. title/label/slug são congelados no momento em que o vínculo foi criado. catalog (CatalogProduct) traz o estado atual do produto vinculado e é resolvido individualmente — pode vir null se o produto vinculado foi excluído do catálogo ou nunca existiu, mesmo com title/slug ainda presentes. | \n
\n\n
\n
Regras de negócio
\n\n- Só
productGroup tem o shopId injetado a partir do seu token. Em ambas as operações a loja é resolvida pela sua conta autenticada, mas apenas productGroup precisa desse valor como argumento — productGroups não expõe (nem aceita) nenhum argumento de loja. \n- Grupo/lista vazia não é erro. Um grupo inativo, excluído, ou que não existe para o
productId/erpCode informado faz productGroup retornar null. productGroups sempre retorna uma connection (nunca null), possivelmente com nodes: []. \n- Paginação Relay (
productGroups, catalogItems). Retorna uma connection com edges ({ cursor, node }), nodes (atalho sem o wrapper de cursor), pageInfo (hasNextPage, hasPreviousPage, startCursor, endCursor) e totalCount. Para avançar, envie first + after: <pageInfo.endCursor>; para retroceder, last + before: <pageInfo.startCursor>. Alternativamente, offset pagina por deslocamento numérico — não combine last com offset na mesma chamada (erro de validação). first/last aceitam de 1 a 50; se nenhum for enviado, o tamanho de página padrão é 20. \n- O tratamento de produtos vinculados difere entre as duas operações.
productGroup filtra os linkedProducts (excluindo vinculados com catálogo removido ou esgotados, salvo flags) e popula imageUrls; productGroups retorna os linkedProducts como cadastrados e não popula imageUrls. Ver as Notas de cada operação para o comportamento exato e como usar linkedProducts[].catalog para checar a validade do seu lado. \n
\n","_postman_id":"f50ccc4d-8883-4c9d-bfc6-3a1c06b5366c"},{"name":"Discounts Codes","item":[{"name":"Query","item":[{"name":"[Query] discountCode","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns discountCode data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"discountCode\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"discountCode returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.discountCode;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.calculation !== undefined && data.calculation !== null) {"," pm.expect(data.calculation).to.be.an(\"object\");"," }"," if (data.code !== undefined && data.code !== null) {"," pm.expect(typeof data.code).to.equal(\"string\");"," }"," if (data.conditions !== undefined && data.conditions !== null) {"," pm.expect(data.conditions).to.be.an(\"object\");"," }"," if (data.description !== undefined && data.description !== null) {"," pm.expect(typeof data.description).to.equal(\"string\");"," }"," if (data.discountMethod !== undefined && data.discountMethod !== null) {"," pm.expect(typeof data.discountMethod).to.equal(\"string\");"," }"," if (data.label !== undefined && data.label !== null) {"," pm.expect(typeof data.label).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"shop\");"," if (data.shop !== undefined && data.shop !== null) {"," pm.expect(data.shop).to.be.an(\"object\");"," }"," if (data.transactions !== undefined && data.transactions !== null) {"," pm.expect(data.transactions).to.be.an(\"array\");"," }"," pm.expect(data).to.have.property(\"enabled\");"," if (data.enabled !== undefined && data.enabled !== null) {"," pm.expect(typeof data.enabled).to.equal(\"boolean\");"," }"," }","});"]}}],"id":"d7bdacf5-6a9e-51d9-a5fa-eade5724c90c","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCode($discountCodeId: ID!) {\n discountCode(discountCodeId: $discountCodeId) {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n}","variables":"{\n \"discountCodeId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"discountCode
\nPropósito: Retorna um cupom de desconto específico da sua loja, pelo ID.\nQuando usar: Para verificar o estado atual de um cupom já conhecido (habilitado, condições, vigência) antes de exibi-lo, atualizá-lo ou removê-lo.\nAutenticação: x-api-key + Authorization. A busca é restrita à sua loja autenticada — esta operação não recebe um argumento de loja.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ndiscountCodeId | \nID! | \nSim | \n— | \nID do cupom de desconto a buscar. | \n
\n\n
\n
Retorno
\nDiscount:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nID do cupom. | \n
\n\ncode | \nString | \nO código que o comprador digita para aplicar o desconto. | \n
\n\nlabel | \nString | \nRótulo descritivo do cupom, para uso interno da sua equipe. | \n
\n\ndescription | \nString | \nDescrição livre do cupom. | \n
\n\ndiscountMethod | \nDiscountMethodEnum | \nSempre CODE para cupons retornados por esta operação. | \n
\n\ncalculation | \nDiscountCalculation | \nComo o desconto é calculado. O formato varia por method — ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\nconditions | \nDiscountConditions | \nCondições de aplicação (limites, datas de vigência, tipo de produto). Ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\nenabled | \nBoolean! | \nSe o cupom está habilitado para uso. | \n
\n\nshop | \nShop! | \nA loja à qual este cupom pertence. | \n
\n\ntransactions | \n[Order] | \nPedidos em que este cupom já foi utilizado. | \n
\n\ncreatedAt | \nAWSDateTime! | \nData de criação do cupom. | \n
\n\nupdatedAt | \nAWSDateTime! | \nData da última atualização do cupom. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nDISCOUNT_CODE_NOT_FOUND_ERROR | \ndiscountCodeId não existe, pertence a outra loja, foi removido (soft-delete) ou não é um cupom por código. | \nConfirme o ID e que o cupom ainda não foi removido; use discountCodes para localizar o ID correto. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Cupons removidos (soft-delete) são tratados como inexistentes. Depois de um
deleteDiscountCode, esta busca passa a retornar DISCOUNT_CODE_NOT_FOUND_ERROR para o mesmo ID. \n- Só cupons por código. Se o ID pertencer a um desconto automático de loja (sem código), esta operação também retorna
DISCOUNT_CODE_NOT_FOUND_ERROR, como se não existisse. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3e7f0ad2-1390-431a-96c5-7753079e91f3","name":"200 - discountCode","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCode($discountCodeId: ID!) {\n discountCode(discountCodeId: $discountCodeId) {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n}","variables":"{\n \"discountCodeId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## discountCode\n\n**Propósito:** Retorna um cupom de desconto específico da sua loja, pelo ID.\n**Quando usar:** Para verificar o estado atual de um cupom já conhecido (habilitado, condições, vigência) antes de exibi-lo, atualizá-lo ou removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. A busca é restrita à sua loja autenticada — esta operação não recebe um argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ----- | ----------- | ------- | --------------------------------- |\n| `discountCodeId` | `ID!` | Sim | — | ID do cupom de desconto a buscar. |\n\n### Retorno\n\n`Discount`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do cupom. |\n| `code` | `String` | O código que o comprador digita para aplicar o desconto. |\n| `label` | `String` | Rótulo descritivo do cupom, para uso interno da sua equipe. |\n| `description` | `String` | Descrição livre do cupom. |\n| `discountMethod` | `DiscountMethodEnum` | Sempre `CODE` para cupons retornados por esta operação. |\n| `calculation` | `DiscountCalculation` | Como o desconto é calculado. O formato varia por `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `conditions` | `DiscountConditions` | Condições de aplicação (limites, datas de vigência, tipo de produto). Ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `enabled` | `Boolean!` | Se o cupom está habilitado para uso. |\n| `shop` | `Shop!` | A loja à qual este cupom pertence. |\n| `transactions` | `[Order]` | Pedidos em que este cupom já foi utilizado. |\n| `createdAt` | `AWSDateTime!` | Data de criação do cupom. |\n| `updatedAt` | `AWSDateTime!` | Data da última atualização do cupom. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountCodeId` não existe, pertence a outra loja, foi removido (soft-delete) ou não é um cupom por código. | Confirme o ID e que o cupom ainda não foi removido; use `discountCodes` para localizar o ID correto. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Cupons removidos (soft-delete) são tratados como inexistentes.** Depois de um `deleteDiscountCode`, esta busca passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **Só cupons por código.** Se o ID pertencer a um desconto automático de loja (sem código), esta operação também retorna `DISCOUNT_CODE_NOT_FOUND_ERROR`, como se não existisse."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"discountCode\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"redemptionLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"transactions\": [\n {\n \"_id\": \"Example_ID\",\n \"cartId\": \"Example_ID\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayStatus\": \"Example_String\",\n \"email\": \"cliente@exemplo.com\",\n \"recurringOrderId\": \"Example_String\",\n \"recurringOrderCycleId\": \"Example_String\",\n \"generatedNewRecurringOrder\": true,\n \"recurringOrderFrequencyId\": \"Example_String\",\n \"referenceId\": \"Example_String\",\n \"source\": \"Example_String\",\n \"status\": \"CANCELED\",\n \"totalItemQuantity\": 10,\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"invoiceIssued\": true,\n \"sentToERP\": true,\n \"soldToCompany\": true,\n \"sentToLP\": true,\n \"dispatched\": true,\n \"delivered\": true,\n \"problemDelivering\": true,\n \"isBoletoPaid\": true,\n \"shippingLabelPending\": true,\n \"shippingLabelFailed\": true\n }\n ],\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n }\n}"},{"id":"27cbb344-f658-4565-849d-7de8e227211f","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCode($discountCodeId: ID!) {\n discountCode(discountCodeId: $discountCodeId) {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n}","variables":"{\n \"discountCodeId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## discountCode\n\n**Propósito:** Retorna um cupom de desconto específico da sua loja, pelo ID.\n**Quando usar:** Para verificar o estado atual de um cupom já conhecido (habilitado, condições, vigência) antes de exibi-lo, atualizá-lo ou removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. A busca é restrita à sua loja autenticada — esta operação não recebe um argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ----- | ----------- | ------- | --------------------------------- |\n| `discountCodeId` | `ID!` | Sim | — | ID do cupom de desconto a buscar. |\n\n### Retorno\n\n`Discount`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do cupom. |\n| `code` | `String` | O código que o comprador digita para aplicar o desconto. |\n| `label` | `String` | Rótulo descritivo do cupom, para uso interno da sua equipe. |\n| `description` | `String` | Descrição livre do cupom. |\n| `discountMethod` | `DiscountMethodEnum` | Sempre `CODE` para cupons retornados por esta operação. |\n| `calculation` | `DiscountCalculation` | Como o desconto é calculado. O formato varia por `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `conditions` | `DiscountConditions` | Condições de aplicação (limites, datas de vigência, tipo de produto). Ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `enabled` | `Boolean!` | Se o cupom está habilitado para uso. |\n| `shop` | `Shop!` | A loja à qual este cupom pertence. |\n| `transactions` | `[Order]` | Pedidos em que este cupom já foi utilizado. |\n| `createdAt` | `AWSDateTime!` | Data de criação do cupom. |\n| `updatedAt` | `AWSDateTime!` | Data da última atualização do cupom. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountCodeId` não existe, pertence a outra loja, foi removido (soft-delete) ou não é um cupom por código. | Confirme o ID e que o cupom ainda não foi removido; use `discountCodes` para localizar o ID correto. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Cupons removidos (soft-delete) são tratados como inexistentes.** Depois de um `deleteDiscountCode`, esta busca passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **Só cupons por código.** Se o ID pertencer a um desconto automático de loja (sem código), esta operação também retorna `DISCOUNT_CODE_NOT_FOUND_ERROR`, como se não existisse."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"5dbabe69-b43b-48ba-bd92-556515da39b0","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCode($discountCodeId: ID!) {\n discountCode(discountCodeId: $discountCodeId) {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n}","variables":"{\n \"discountCodeId\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## discountCode\n\n**Propósito:** Retorna um cupom de desconto específico da sua loja, pelo ID.\n**Quando usar:** Para verificar o estado atual de um cupom já conhecido (habilitado, condições, vigência) antes de exibi-lo, atualizá-lo ou removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. A busca é restrita à sua loja autenticada — esta operação não recebe um argumento de loja.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | ----- | ----------- | ------- | --------------------------------- |\n| `discountCodeId` | `ID!` | Sim | — | ID do cupom de desconto a buscar. |\n\n### Retorno\n\n`Discount`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do cupom. |\n| `code` | `String` | O código que o comprador digita para aplicar o desconto. |\n| `label` | `String` | Rótulo descritivo do cupom, para uso interno da sua equipe. |\n| `description` | `String` | Descrição livre do cupom. |\n| `discountMethod` | `DiscountMethodEnum` | Sempre `CODE` para cupons retornados por esta operação. |\n| `calculation` | `DiscountCalculation` | Como o desconto é calculado. O formato varia por `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `conditions` | `DiscountConditions` | Condições de aplicação (limites, datas de vigência, tipo de produto). Ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `enabled` | `Boolean!` | Se o cupom está habilitado para uso. |\n| `shop` | `Shop!` | A loja à qual este cupom pertence. |\n| `transactions` | `[Order]` | Pedidos em que este cupom já foi utilizado. |\n| `createdAt` | `AWSDateTime!` | Data de criação do cupom. |\n| `updatedAt` | `AWSDateTime!` | Data da última atualização do cupom. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |\n| `DISCOUNT_CODE_NOT_FOUND_ERROR` | `discountCodeId` não existe, pertence a outra loja, foi removido (soft-delete) ou não é um cupom por código. | Confirme o ID e que o cupom ainda não foi removido; use `discountCodes` para localizar o ID correto. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Cupons removidos (soft-delete) são tratados como inexistentes.** Depois de um `deleteDiscountCode`, esta busca passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **Só cupons por código.** Se o ID pertencer a um desconto automático de loja (sem código), esta operação também retorna `DISCOUNT_CODE_NOT_FOUND_ERROR`, como se não existisse."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"d7bdacf5-6a9e-51d9-a5fa-eade5724c90c"},{"name":"[Query] discountCodes","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns discountCodes data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"discountCodes\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"discountCodes returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.discountCodes;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"d9ff7138-2c5e-5cbe-a763-2de09c625b1e","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCodes($filters: DiscountCodeFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: DiscountCodesSortByField) {\n discountCodes(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n nodes {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"searchField\": \"Example_String\",\n \"code\": \"Example_String\",\n \"enabled\": true,\n \"calculationMethod\": [\n \"DISCOUNT\"\n ],\n \"redemptionLimitReached\": true,\n \"productType\": [\n \"ALL\"\n ],\n \"startDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"endDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"createdAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"updatedAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"amountOfRedemptions\"\n}"}},"url":"{{base_url}}","description":"discountCodes
\nPropósito: Lista os cupons de desconto da sua loja, com filtros e paginação.\nQuando usar: Para pesquisar/exibir o catálogo de cupons cadastrados (ex.: um painel de gestão de descontos), ou para localizar o ID de um cupom antes de atualizá-lo/removê-lo.\nAutenticação: x-api-key + Authorization. O shopId é injetado a partir do seu token — não envie esse argumento.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nDiscountCodeFilterInput | \nNão | \n— | \nFiltros a aplicar. Ver tabela abaixo. | \n
\n\nafter | \nString | \nNão | \n— | \nRetorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \n— | \nRetorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Pode ser combinado com after ou offset. | \n
\n\nlast | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Pode ser combinado com before. | \n
\n\noffset | \nInt | \nNão | \n— | \nPula os N primeiros resultados. Pode ser combinado com first. | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nOrdem dos resultados (asc/desc). | \n
\n\nsortBy | \nDiscountCodesSortByField | \nNão | \ncreatedAt | \nCampo de ordenação — ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\n
\n
\n\n\n| Campo | \nTipo | \nDescrição | \n
\n\n\n\nsearchField | \nString | \nBusca livre por code, label ou description (parcial, sem diferenciar maiúsculas/minúsculas). | \n
\n\ncode | \nString | \nFiltra por code (busca parcial, sem diferenciar maiúsculas/minúsculas). | \n
\n\nenabled | \nBoolean | \nFiltra por cupons habilitados (true) ou desabilitados (false). | \n
\n\ncalculationMethod | \n[DiscountCalculationMethodEnum] | \nFiltra por um ou mais métodos de cálculo — ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\nredemptionLimitReached | \nBoolean | \nFiltra cupons que já atingiram (ou não) o limite de resgates definido em conditions.redemptionLimit. | \n
\n\nproductType | \n[DiscountProductTypeEnum] | \nFiltra por um ou mais tipos de produto elegíveis (conditions.productType). | \n
\n\nstartDate / endDate | \nDateTimeFilterByRangeInput | \nFiltra por intervalo de datas de início/fim de vigência (conditions.startDate/endDate). Aceita eq, gt, gte, lt, lte. | \n
\n\ncreatedAt / updatedAt | \nDateTimeFilterByRangeInput | \nFiltra por intervalo de datas de criação/atualização do cupom. | \n
\n\n
\n
Retorno
\nDiscountCodeConnection:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes | \n[Discount] | \nLista direta de cupons, sem o envelope de paginação. Mesmos campos de discountCode. | \n
\n\nedges | \n[DiscountCodeEdge] | \nCada item envolvido em um cursor, para uso em paginação. | \n
\n\nedges[].cursor | \nString! | \nCursor do item, use em after/before na próxima chamada. | \n
\n\nedges[].node | \nDiscount | \nO cupom. Mesmos campos de discountCode. | \n
\n\npageInfo | \nPageInfo! | \nInformações de paginação (se há próxima/página anterior). | \n
\n\ntotalCount | \nInt! | \nTotal de cupons que casam com os filtros, independente da página atual. | \n
\n\n
\n
Erros
\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (access_token ausente ou expirado) seguem o padrão geral descrito na Overview.
\n\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Esta operação só retorna cupons por código (
discountMethod: CODE). A API de parceiros força esse filtro do seu lado — não há um argumento discountMethod para pedir outros métodos (ex.: descontos automáticos de loja). \n- Cupons removidos (soft-delete) e descontos automáticos de loja nunca aparecem nesta lista, independentemente dos filtros usados.
\nsortBy: amountOfRedemptions ordena por um valor que não é exposto no retorno. Você pode ordenar por quantidade de resgates, mas essa contagem não aparece em nenhum campo de Discount — para exibi-la ao usuário, mantenha sua própria contagem ou trate a ordenação como um recurso de exibição sem valor numérico associado.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cf7ed3fd-5940-499c-81ce-36e53e16be42","name":"200 - discountCodes","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCodes($filters: DiscountCodeFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: DiscountCodesSortByField) {\n discountCodes(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n nodes {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"searchField\": \"Example_String\",\n \"code\": \"Example_String\",\n \"enabled\": true,\n \"calculationMethod\": [\n \"DISCOUNT\"\n ],\n \"redemptionLimitReached\": true,\n \"productType\": [\n \"ALL\"\n ],\n \"startDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"endDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"createdAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"updatedAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"amountOfRedemptions\"\n}"}},"url":"{{base_url}}","description":"## discountCodes\n\n**Propósito:** Lista os cupons de desconto da sua loja, com filtros e paginação.\n**Quando usar:** Para pesquisar/exibir o catálogo de cupons cadastrados (ex.: um painel de gestão de descontos), ou para localizar o ID de um cupom antes de atualizá-lo/removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | -------------------------------------------------------------------------------------------- |\n| `filters` | `DiscountCodeFilterInput` | Não | — | Filtros a aplicar. Ver tabela abaixo. |\n| `after` | `String` | Não | — | Retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem dos resultados (`asc`/`desc`). |\n| `sortBy` | `DiscountCodesSortByField` | Não | `createdAt` | Campo de ordenação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n\n#### Campos de `filters` (`DiscountCodeFilterInput`)\n\n| Campo | Tipo | Descrição |\n| ------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| `searchField` | `String` | Busca livre por `code`, `label` ou `description` (parcial, sem diferenciar maiúsculas/minúsculas). |\n| `code` | `String` | Filtra por `code` (busca parcial, sem diferenciar maiúsculas/minúsculas). |\n| `enabled` | `Boolean` | Filtra por cupons habilitados (`true`) ou desabilitados (`false`). |\n| `calculationMethod` | `[DiscountCalculationMethodEnum]` | Filtra por um ou mais métodos de cálculo — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `redemptionLimitReached` | `Boolean` | Filtra cupons que já atingiram (ou não) o limite de resgates definido em `conditions.redemptionLimit`. |\n| `productType` | `[DiscountProductTypeEnum]` | Filtra por um ou mais tipos de produto elegíveis (`conditions.productType`). |\n| `startDate` / `endDate` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de início/fim de vigência (`conditions.startDate`/`endDate`). Aceita `eq`, `gt`, `gte`, `lt`, `lte`. |\n| `createdAt` / `updatedAt` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de criação/atualização do cupom. |\n\n### Retorno\n\n`DiscountCodeConnection`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | -------------------- | ------------------------------------------------------------------------------------- |\n| `nodes` | `[Discount]` | Lista direta de cupons, sem o envelope de paginação. Mesmos campos de `discountCode`. |\n| `edges` | `[DiscountCodeEdge]` | Cada item envolvido em um `cursor`, para uso em paginação. |\n| `edges[].cursor` | `String!` | Cursor do item, use em `after`/`before` na próxima chamada. |\n| `edges[].node` | `Discount` | O cupom. Mesmos campos de `discountCode`. |\n| `pageInfo` | `PageInfo!` | Informações de paginação (se há próxima/página anterior). |\n| `totalCount` | `Int!` | Total de cupons que casam com os filtros, independente da página atual. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Esta operação só retorna cupons por código (`discountMethod: CODE`).** A API de parceiros força esse filtro do seu lado — não há um argumento `discountMethod` para pedir outros métodos (ex.: descontos automáticos de loja).\n- **Cupons removidos (soft-delete) e descontos automáticos de loja nunca aparecem nesta lista**, independentemente dos filtros usados.\n- **`sortBy: amountOfRedemptions` ordena por um valor que não é exposto no retorno.** Você pode ordenar por quantidade de resgates, mas essa contagem não aparece em nenhum campo de `Discount` — para exibi-la ao usuário, mantenha sua própria contagem ou trate a ordenação como um recurso de exibição sem valor numérico associado."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"discountCodes\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"cf88de14-76f7-4179-8ca3-6145ceefb2a3","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCodes($filters: DiscountCodeFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: DiscountCodesSortByField) {\n discountCodes(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n nodes {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"searchField\": \"Example_String\",\n \"code\": \"Example_String\",\n \"enabled\": true,\n \"calculationMethod\": [\n \"DISCOUNT\"\n ],\n \"redemptionLimitReached\": true,\n \"productType\": [\n \"ALL\"\n ],\n \"startDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"endDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"createdAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"updatedAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"amountOfRedemptions\"\n}"}},"url":"{{base_url}}","description":"## discountCodes\n\n**Propósito:** Lista os cupons de desconto da sua loja, com filtros e paginação.\n**Quando usar:** Para pesquisar/exibir o catálogo de cupons cadastrados (ex.: um painel de gestão de descontos), ou para localizar o ID de um cupom antes de atualizá-lo/removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | -------------------------------------------------------------------------------------------- |\n| `filters` | `DiscountCodeFilterInput` | Não | — | Filtros a aplicar. Ver tabela abaixo. |\n| `after` | `String` | Não | — | Retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem dos resultados (`asc`/`desc`). |\n| `sortBy` | `DiscountCodesSortByField` | Não | `createdAt` | Campo de ordenação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n\n#### Campos de `filters` (`DiscountCodeFilterInput`)\n\n| Campo | Tipo | Descrição |\n| ------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| `searchField` | `String` | Busca livre por `code`, `label` ou `description` (parcial, sem diferenciar maiúsculas/minúsculas). |\n| `code` | `String` | Filtra por `code` (busca parcial, sem diferenciar maiúsculas/minúsculas). |\n| `enabled` | `Boolean` | Filtra por cupons habilitados (`true`) ou desabilitados (`false`). |\n| `calculationMethod` | `[DiscountCalculationMethodEnum]` | Filtra por um ou mais métodos de cálculo — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `redemptionLimitReached` | `Boolean` | Filtra cupons que já atingiram (ou não) o limite de resgates definido em `conditions.redemptionLimit`. |\n| `productType` | `[DiscountProductTypeEnum]` | Filtra por um ou mais tipos de produto elegíveis (`conditions.productType`). |\n| `startDate` / `endDate` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de início/fim de vigência (`conditions.startDate`/`endDate`). Aceita `eq`, `gt`, `gte`, `lt`, `lte`. |\n| `createdAt` / `updatedAt` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de criação/atualização do cupom. |\n\n### Retorno\n\n`DiscountCodeConnection`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | -------------------- | ------------------------------------------------------------------------------------- |\n| `nodes` | `[Discount]` | Lista direta de cupons, sem o envelope de paginação. Mesmos campos de `discountCode`. |\n| `edges` | `[DiscountCodeEdge]` | Cada item envolvido em um `cursor`, para uso em paginação. |\n| `edges[].cursor` | `String!` | Cursor do item, use em `after`/`before` na próxima chamada. |\n| `edges[].node` | `Discount` | O cupom. Mesmos campos de `discountCode`. |\n| `pageInfo` | `PageInfo!` | Informações de paginação (se há próxima/página anterior). |\n| `totalCount` | `Int!` | Total de cupons que casam com os filtros, independente da página atual. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Esta operação só retorna cupons por código (`discountMethod: CODE`).** A API de parceiros força esse filtro do seu lado — não há um argumento `discountMethod` para pedir outros métodos (ex.: descontos automáticos de loja).\n- **Cupons removidos (soft-delete) e descontos automáticos de loja nunca aparecem nesta lista**, independentemente dos filtros usados.\n- **`sortBy: amountOfRedemptions` ordena por um valor que não é exposto no retorno.** Você pode ordenar por quantidade de resgates, mas essa contagem não aparece em nenhum campo de `Discount` — para exibi-la ao usuário, mantenha sua própria contagem ou trate a ordenação como um recurso de exibição sem valor numérico associado."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"1f3c21c0-7d49-432a-ab96-ca09d9c9f258","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query DiscountCodes($filters: DiscountCodeFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: DiscountCodesSortByField) {\n discountCodes(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n nodes {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"searchField\": \"Example_String\",\n \"code\": \"Example_String\",\n \"enabled\": true,\n \"calculationMethod\": [\n \"DISCOUNT\"\n ],\n \"redemptionLimitReached\": true,\n \"productType\": [\n \"ALL\"\n ],\n \"startDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"endDate\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"createdAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"updatedAt\": {\n \"eq\": \"2025-01-15T10:00:00Z\",\n \"gt\": \"2025-01-15T10:00:00Z\",\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lt\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"amountOfRedemptions\"\n}"}},"url":"{{base_url}}","description":"## discountCodes\n\n**Propósito:** Lista os cupons de desconto da sua loja, com filtros e paginação.\n**Quando usar:** Para pesquisar/exibir o catálogo de cupons cadastrados (ex.: um painel de gestão de descontos), ou para localizar o ID de um cupom antes de atualizá-lo/removê-lo.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | -------------------------------------------------------------------------------------------- |\n| `filters` | `DiscountCodeFilterInput` | Não | — | Filtros a aplicar. Ver tabela abaixo. |\n| `after` | `String` | Não | — | Retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Pode ser combinado com `before`. |\n| `offset` | `Int` | Não | — | Pula os N primeiros resultados. Pode ser combinado com `first`. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem dos resultados (`asc`/`desc`). |\n| `sortBy` | `DiscountCodesSortByField` | Não | `createdAt` | Campo de ordenação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n\n#### Campos de `filters` (`DiscountCodeFilterInput`)\n\n| Campo | Tipo | Descrição |\n| ------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| `searchField` | `String` | Busca livre por `code`, `label` ou `description` (parcial, sem diferenciar maiúsculas/minúsculas). |\n| `code` | `String` | Filtra por `code` (busca parcial, sem diferenciar maiúsculas/minúsculas). |\n| `enabled` | `Boolean` | Filtra por cupons habilitados (`true`) ou desabilitados (`false`). |\n| `calculationMethod` | `[DiscountCalculationMethodEnum]` | Filtra por um ou mais métodos de cálculo — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `redemptionLimitReached` | `Boolean` | Filtra cupons que já atingiram (ou não) o limite de resgates definido em `conditions.redemptionLimit`. |\n| `productType` | `[DiscountProductTypeEnum]` | Filtra por um ou mais tipos de produto elegíveis (`conditions.productType`). |\n| `startDate` / `endDate` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de início/fim de vigência (`conditions.startDate`/`endDate`). Aceita `eq`, `gt`, `gte`, `lt`, `lte`. |\n| `createdAt` / `updatedAt` | `DateTimeFilterByRangeInput` | Filtra por intervalo de datas de criação/atualização do cupom. |\n\n### Retorno\n\n`DiscountCodeConnection`:\n\n| Propriedade | Tipo | Descrição |\n| ---------------- | -------------------- | ------------------------------------------------------------------------------------- |\n| `nodes` | `[Discount]` | Lista direta de cupons, sem o envelope de paginação. Mesmos campos de `discountCode`. |\n| `edges` | `[DiscountCodeEdge]` | Cada item envolvido em um `cursor`, para uso em paginação. |\n| `edges[].cursor` | `String!` | Cursor do item, use em `after`/`before` na próxima chamada. |\n| `edges[].node` | `Discount` | O cupom. Mesmos campos de `discountCode`. |\n| `pageInfo` | `PageInfo!` | Informações de paginação (se há próxima/página anterior). |\n| `totalCount` | `Int!` | Total de cupons que casam com os filtros, independente da página atual. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Esta operação só retorna cupons por código (`discountMethod: CODE`).** A API de parceiros força esse filtro do seu lado — não há um argumento `discountMethod` para pedir outros métodos (ex.: descontos automáticos de loja).\n- **Cupons removidos (soft-delete) e descontos automáticos de loja nunca aparecem nesta lista**, independentemente dos filtros usados.\n- **`sortBy: amountOfRedemptions` ordena por um valor que não é exposto no retorno.** Você pode ordenar por quantidade de resgates, mas essa contagem não aparece em nenhum campo de `Discount` — para exibi-la ao usuário, mantenha sua própria contagem ou trate a ordenação como um recurso de exibição sem valor numérico associado."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"d9ff7138-2c5e-5cbe-a763-2de09c625b1e"}],"id":"4948d5ec-ae8a-4342-9254-e8d6353522ad","_postman_id":"4948d5ec-ae8a-4342-9254-e8d6353522ad","description":""},{"name":"Mutation","item":[{"name":"[Mutation] createDiscountCode","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns createDiscountCode data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"createDiscountCode\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"2c993532-8f0a-55a3-a360-08c6ec89458a","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateDiscountCode($input: CreateDiscountCodeInput!) {\n createDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n }\n }\n}"}},"url":"{{base_url}}","description":"createDiscountCode
\nPropósito: Cria um novo cupom de desconto para a sua loja.\nQuando usar: Sempre que quiser lançar um novo cupom promocional. Não é idempotente: cada chamada bem-sucedida cria um cupom novo. A única proteção contra duplicidade é a regra de negócio sobre code (ver Notas) — não há deduplicação por clientMutationId nem por qualquer outro campo.\nAutenticação: x-api-key + Authorization. O cupom é criado na sua loja autenticada — não há argumento de loja.
\nArgumentos
\nÚnico argumento: input: CreateDiscountCodeInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.clientMutationId | \nString | \nNão | \nnull | \nEcoado de volta na resposta, para você correlacionar chamadas. | \n
\n\ninput.discountCode | \nDiscountCodeInputCreate | \nSim, na prática | \n— | \nDados do cupom. O schema marca este campo como opcional, mas omiti-lo causa um erro de requisição — sempre envie. | \n
\n\ninput.discountCode.code | \nString! | \nSim | \n— | \nO código que o comprador vai digitar. Espaços nas pontas são removidos automaticamente antes de salvar. | \n
\n\ninput.discountCode.enabled | \nBoolean! | \nSim | \n— | \nSe o cupom já nasce habilitado para uso. | \n
\n\ninput.discountCode.discountMethod | \nDiscountMethodEnum | \nSim, na prática | \n— | \nO schema marca como opcional, mas omiti-lo causa um erro de validação. Envie sempre CODE — é o único valor aceito neste folder. | \n
\n\ninput.discountCode.calculation | \nAWSJSON | \nSim, na prática | \n— | \nO schema marca como opcional, mas omiti-lo causa um erro de validação. Objeto { method, ...campos } — formato depende de method, ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\ninput.discountCode.conditions | \nDiscountConditionsInput | \nNão | \nVer Notas | \nCondições de aplicação — ver a seção Tipos e enums compartilhados na descrição deste folder. | \n
\n\ninput.discountCode.description | \nString | \nNão | \nnull | \nDescrição livre do cupom. | \n
\n\ninput.discountCode.label | \nString | \nNão | \nnull | \nRótulo descritivo, para uso interno da sua equipe. | \n
\n\n
\n
Retorno
\nCreateDiscountCodePayload:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nclientMutationId | \nString | \nO mesmo valor enviado no argumento, se enviado. | \n
\n\ndiscountCode | \nDiscount | \nO cupom recém-criado. Mesmos campos retornados por discountCode. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nDUPLICATE_DISCOUNT_CODE_ERROR | \nJá existe, na sua loja, um cupom habilitado, não removido e dentro do período de vigência com o mesmo code (ver Notas no folder). | \nUse um code diferente, ou aguarde o cupom existente expirar/desabilite-o antes de reenviar o mesmo code. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. Além do código acima, campos obrigatórios ausentes ou um calculation com formato incompatível com o method informado retornam um erro de validação sem extensions.code estável — verifique sempre message nesse caso.
\n
\nNotas
\n\ndiscountMethod e calculation são opcionais no schema GraphQL, mas obrigatórios na prática. Omiti-los não gera o erro de duplicidade acima, e sim uma falha de validação genérica. Sempre envie discountMethod: CODE e um calculation completo.- Se
conditions.productType não for enviado, o cupom nasce com NON_RECURRING (não com ALL). Se você quer que o cupom valha para todos os produtos, envie conditions: { productType: ALL } explicitamente. \n- A verificação de duplicidade de
code não diferencia maiúsculas/minúsculas e ignora espaços nas pontas — \"VERAO10\" e \" verao10 \" são tratados como o mesmo código para esse fim. \n- A verificação de duplicidade só considera cupons \"ativos\" no momento da criação (habilitados, não removidos e dentro da janela
startDate/endDate). Reaproveitar o code de um cupom já expirado, ainda não iniciado ou desabilitado é permitido. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4243671d-1c8d-4240-a0bf-bc6a7a89b0e7","name":"200 - createDiscountCode","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateDiscountCode($input: CreateDiscountCodeInput!) {\n createDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n }\n }\n}"}},"url":"{{base_url}}","description":"## createDiscountCode\n\n**Propósito:** Cria um novo cupom de desconto para a sua loja.\n**Quando usar:** Sempre que quiser lançar um novo cupom promocional. **Não é idempotente**: cada chamada bem-sucedida cria um cupom novo. A única proteção contra duplicidade é a regra de negócio sobre `code` (ver Notas) — não há deduplicação por `clientMutationId` nem por qualquer outro campo.\n**Autenticação:** `x-api-key` + `Authorization`. O cupom é criado na sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCode` | `DiscountCodeInputCreate` | Sim, na prática | — | Dados do cupom. O schema marca este campo como opcional, mas omiti-lo causa um erro de requisição — sempre envie. |\n| `input.discountCode.code` | `String!` | Sim | — | O código que o comprador vai digitar. Espaços nas pontas são removidos automaticamente antes de salvar. |\n| `input.discountCode.enabled` | `Boolean!` | Sim | — | Se o cupom já nasce habilitado para uso. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Envie sempre `CODE` — é o único valor aceito neste folder. |\n| `input.discountCode.calculation` | `AWSJSON` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Objeto `{ method, ...campos }` — formato depende de `method`, ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | Ver Notas | Condições de aplicação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.description` | `String` | Não | `null` | Descrição livre do cupom. |\n| `input.discountCode.label` | `String` | Não | `null` | Rótulo descritivo, para uso interno da sua equipe. |\n\n### Retorno\n\n`CreateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ------------------------------------------------------------------ |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom recém-criado. Mesmos campos retornados por `discountCode`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |\n| `DUPLICATE_DISCOUNT_CODE_ERROR` | Já existe, na sua loja, um cupom habilitado, não removido e dentro do período de vigência com o mesmo `code` (ver Notas no folder). | Use um `code` diferente, ou aguarde o cupom existente expirar/desabilite-o antes de reenviar o mesmo `code`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Além do código acima, campos obrigatórios ausentes ou um `calculation` com formato incompatível com o `method` informado retornam um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **`discountMethod` e `calculation` são opcionais no schema GraphQL, mas obrigatórios na prática.** Omiti-los não gera o erro de duplicidade acima, e sim uma falha de validação genérica. Sempre envie `discountMethod: CODE` e um `calculation` completo.\n- **Se `conditions.productType` não for enviado, o cupom nasce com `NON_RECURRING`** (não com `ALL`). Se você quer que o cupom valha para todos os produtos, envie `conditions: { productType: ALL }` explicitamente.\n- **A verificação de duplicidade de `code` não diferencia maiúsculas/minúsculas** e ignora espaços nas pontas — `\"VERAO10\"` e `\" verao10 \"` são tratados como o mesmo código para esse fim.\n- **A verificação de duplicidade só considera cupons \"ativos\" no momento da criação** (habilitados, não removidos e dentro da janela `startDate`/`endDate`). Reaproveitar o `code` de um cupom já expirado, ainda não iniciado ou desabilitado é permitido."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createDiscountCode\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n }\n }\n}"},{"id":"92d74b08-a11e-4d0a-b1e0-3a6b93504d44","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateDiscountCode($input: CreateDiscountCodeInput!) {\n createDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n }\n }\n}"}},"url":"{{base_url}}","description":"## createDiscountCode\n\n**Propósito:** Cria um novo cupom de desconto para a sua loja.\n**Quando usar:** Sempre que quiser lançar um novo cupom promocional. **Não é idempotente**: cada chamada bem-sucedida cria um cupom novo. A única proteção contra duplicidade é a regra de negócio sobre `code` (ver Notas) — não há deduplicação por `clientMutationId` nem por qualquer outro campo.\n**Autenticação:** `x-api-key` + `Authorization`. O cupom é criado na sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCode` | `DiscountCodeInputCreate` | Sim, na prática | — | Dados do cupom. O schema marca este campo como opcional, mas omiti-lo causa um erro de requisição — sempre envie. |\n| `input.discountCode.code` | `String!` | Sim | — | O código que o comprador vai digitar. Espaços nas pontas são removidos automaticamente antes de salvar. |\n| `input.discountCode.enabled` | `Boolean!` | Sim | — | Se o cupom já nasce habilitado para uso. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Envie sempre `CODE` — é o único valor aceito neste folder. |\n| `input.discountCode.calculation` | `AWSJSON` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Objeto `{ method, ...campos }` — formato depende de `method`, ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | Ver Notas | Condições de aplicação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.description` | `String` | Não | `null` | Descrição livre do cupom. |\n| `input.discountCode.label` | `String` | Não | `null` | Rótulo descritivo, para uso interno da sua equipe. |\n\n### Retorno\n\n`CreateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ------------------------------------------------------------------ |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom recém-criado. Mesmos campos retornados por `discountCode`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |\n| `DUPLICATE_DISCOUNT_CODE_ERROR` | Já existe, na sua loja, um cupom habilitado, não removido e dentro do período de vigência com o mesmo `code` (ver Notas no folder). | Use um `code` diferente, ou aguarde o cupom existente expirar/desabilite-o antes de reenviar o mesmo `code`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Além do código acima, campos obrigatórios ausentes ou um `calculation` com formato incompatível com o `method` informado retornam um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **`discountMethod` e `calculation` são opcionais no schema GraphQL, mas obrigatórios na prática.** Omiti-los não gera o erro de duplicidade acima, e sim uma falha de validação genérica. Sempre envie `discountMethod: CODE` e um `calculation` completo.\n- **Se `conditions.productType` não for enviado, o cupom nasce com `NON_RECURRING`** (não com `ALL`). Se você quer que o cupom valha para todos os produtos, envie `conditions: { productType: ALL }` explicitamente.\n- **A verificação de duplicidade de `code` não diferencia maiúsculas/minúsculas** e ignora espaços nas pontas — `\"VERAO10\"` e `\" verao10 \"` são tratados como o mesmo código para esse fim.\n- **A verificação de duplicidade só considera cupons \"ativos\" no momento da criação** (habilitados, não removidos e dentro da janela `startDate`/`endDate`). Reaproveitar o `code` de um cupom já expirado, ainda não iniciado ou desabilitado é permitido."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"b8bf2590-2718-4574-823d-8a6f67120879","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateDiscountCode($input: CreateDiscountCodeInput!) {\n createDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n }\n }\n}"}},"url":"{{base_url}}","description":"## createDiscountCode\n\n**Propósito:** Cria um novo cupom de desconto para a sua loja.\n**Quando usar:** Sempre que quiser lançar um novo cupom promocional. **Não é idempotente**: cada chamada bem-sucedida cria um cupom novo. A única proteção contra duplicidade é a regra de negócio sobre `code` (ver Notas) — não há deduplicação por `clientMutationId` nem por qualquer outro campo.\n**Autenticação:** `x-api-key` + `Authorization`. O cupom é criado na sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: CreateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCode` | `DiscountCodeInputCreate` | Sim, na prática | — | Dados do cupom. O schema marca este campo como opcional, mas omiti-lo causa um erro de requisição — sempre envie. |\n| `input.discountCode.code` | `String!` | Sim | — | O código que o comprador vai digitar. Espaços nas pontas são removidos automaticamente antes de salvar. |\n| `input.discountCode.enabled` | `Boolean!` | Sim | — | Se o cupom já nasce habilitado para uso. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Envie sempre `CODE` — é o único valor aceito neste folder. |\n| `input.discountCode.calculation` | `AWSJSON` | Sim, na prática | — | O schema marca como opcional, mas omiti-lo causa um erro de validação. Objeto `{ method, ...campos }` — formato depende de `method`, ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | Ver Notas | Condições de aplicação — ver a seção **Tipos e enums compartilhados** na descrição deste folder. |\n| `input.discountCode.description` | `String` | Não | `null` | Descrição livre do cupom. |\n| `input.discountCode.label` | `String` | Não | `null` | Rótulo descritivo, para uso interno da sua equipe. |\n\n### Retorno\n\n`CreateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ------------------------------------------------------------------ |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom recém-criado. Mesmos campos retornados por `discountCode`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |\n| `DUPLICATE_DISCOUNT_CODE_ERROR` | Já existe, na sua loja, um cupom habilitado, não removido e dentro do período de vigência com o mesmo `code` (ver Notas no folder). | Use um `code` diferente, ou aguarde o cupom existente expirar/desabilite-o antes de reenviar o mesmo `code`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Além do código acima, campos obrigatórios ausentes ou um `calculation` com formato incompatível com o `method` informado retornam um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **`discountMethod` e `calculation` são opcionais no schema GraphQL, mas obrigatórios na prática.** Omiti-los não gera o erro de duplicidade acima, e sim uma falha de validação genérica. Sempre envie `discountMethod: CODE` e um `calculation` completo.\n- **Se `conditions.productType` não for enviado, o cupom nasce com `NON_RECURRING`** (não com `ALL`). Se você quer que o cupom valha para todos os produtos, envie `conditions: { productType: ALL }` explicitamente.\n- **A verificação de duplicidade de `code` não diferencia maiúsculas/minúsculas** e ignora espaços nas pontas — `\"VERAO10\"` e `\" verao10 \"` são tratados como o mesmo código para esse fim.\n- **A verificação de duplicidade só considera cupons \"ativos\" no momento da criação** (habilitados, não removidos e dentro da janela `startDate`/`endDate`). Reaproveitar o `code` de um cupom já expirado, ainda não iniciado ou desabilitado é permitido."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"2c993532-8f0a-55a3-a360-08c6ec89458a"},{"name":"[Mutation] updateDiscountCode","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns updateDiscountCode data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"updateDiscountCode\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"3cd759ae-74d0-5af7-81f5-42dd37d882bd","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateDiscountCode($input: UpdateDiscountCodeInput!) {\n updateDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n },\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"updateDiscountCode
\nPropósito: Atualiza um cupom de desconto existente na sua loja.\nQuando usar: Para alterar dados de um cupom já criado (habilitar/desabilitar, mudar condições, trocar a forma de cálculo, etc.), sem recriá-lo. É seguro reenviar a mesma chamada (os mesmos campos, com os mesmos valores, produzem o mesmo resultado) — mas veja em Notas o comportamento quando o discountCodeId não é encontrado.\nAutenticação: x-api-key + Authorization. A atualização é restrita a cupons da sua loja autenticada — não há argumento de loja.
\nArgumentos
\nÚnico argumento: input: UpdateDiscountCodeInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.clientMutationId | \nString | \nNão | \nnull | \nEcoado de volta na resposta, para você correlacionar chamadas. | \n
\n\ninput.discountCodeId | \nID! | \nSim | \n— | \nID do cupom a atualizar. | \n
\n\ninput.discountCode | \nDiscountCodeInputUpdate | \nNão | \n— | \nCampos a alterar. Só os campos enviados são modificados — ver Notas sobre merge. | \n
\n\ninput.discountCode.code | \nString | \nNão | \n— | \nNovo código do cupom. | \n
\n\ninput.discountCode.enabled | \nBoolean | \nNão | \n— | \nHabilita/desabilita o cupom. | \n
\n\ninput.discountCode.discountMethod | \nDiscountMethodEnum | \nNão | \n— | \nNão há motivo prático para alterar — este folder só trabalha com CODE. | \n
\n\ninput.discountCode.calculation | \nAWSJSON | \nNão | \n— | \nNovo objeto de cálculo. Pode inclusive trocar o method por completo, desde que o objeto enviado corresponda ao formato exigido pelo novo method — ver a seção Tipos e enums compartilhados na descrição deste folder. Atenção: na atualização, DISCOUNT/SALE exigem valores inteiros e rejeitam decimais (diferente da criação, que trunca) — ver a nota do folder. | \n
\n\ninput.discountCode.conditions | \nDiscountConditionsInput | \nNão | \n— | \nCondições a alterar. Só as chaves enviadas dentro de conditions são modificadas — ver Notas sobre merge. | \n
\n\ninput.discountCode.description | \nString | \nNão | \n— | \nNova descrição. | \n
\n\ninput.discountCode.label | \nString | \nNão | \n— | \nNovo rótulo. | \n
\n\n
\n
Retorno
\nUpdateDiscountCodePayload:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nclientMutationId | \nString | \nO mesmo valor enviado no argumento, se enviado. | \n
\n\ndiscountCode | \nDiscount | \nO cupom após a atualização, com os mesmos campos retornados por discountCode. Ver Notas se discountCodeId não for válido. | \n
\n\n
\n
Erros
\nNenhum código de erro de negócio específico conhecido para esta operação — ver Notas sobre o comportamento quando discountCodeId não é encontrado.
\n\nGraphQL responde HTTP 200 com errors[] em caso de falha. Um calculation com formato incompatível com o method informado retorna um erro de validação sem extensions.code estável — verifique sempre message nesse caso.
\n
\nNotas
\n\n- Merge parcial, não substituição. Só os campos enviados em
discountCode são alterados; qualquer campo omitido mantém o valor atual. O mesmo vale dentro de conditions: enviar conditions: { max: 100 } altera só max, preservando accountLimit, startDate, etc. já configurados. Para limpar um campo opcional (ex.: description, label ou uma chave de conditions), envie-o explicitamente como null. \n- Sem erro dedicado de \"não encontrado\". Se
discountCodeId não existir, pertencer a outra loja, já estiver removido (soft-delete) ou não for um cupom por código, a mutation não lança um erro específico — a atualização simplesmente não é aplicada. Sempre confira os campos em discountCode na resposta para confirmar que a alteração desejada realmente foi aplicada (por exemplo, comparando enabled ou os valores de conditions com o que você enviou). \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b2044c4f-dda3-41ef-a2e6-b992b840fb07","name":"200 - updateDiscountCode","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateDiscountCode($input: UpdateDiscountCodeInput!) {\n updateDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n },\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## updateDiscountCode\n\n**Propósito:** Atualiza um cupom de desconto existente na sua loja.\n**Quando usar:** Para alterar dados de um cupom já criado (habilitar/desabilitar, mudar condições, trocar a forma de cálculo, etc.), sem recriá-lo. **É seguro reenviar a mesma chamada** (os mesmos campos, com os mesmos valores, produzem o mesmo resultado) — mas veja em Notas o comportamento quando o `discountCodeId` não é encontrado.\n**Autenticação:** `x-api-key` + `Authorization`. A atualização é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a atualizar. |\n| `input.discountCode` | `DiscountCodeInputUpdate` | Não | — | Campos a alterar. Só os campos enviados são modificados — ver Notas sobre merge. |\n| `input.discountCode.code` | `String` | Não | — | Novo código do cupom. |\n| `input.discountCode.enabled` | `Boolean` | Não | — | Habilita/desabilita o cupom. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Não | — | Não há motivo prático para alterar — este folder só trabalha com `CODE`. |\n| `input.discountCode.calculation` | `AWSJSON` | Não | — | Novo objeto de cálculo. Pode inclusive trocar o `method` por completo, desde que o objeto enviado corresponda ao formato exigido pelo novo `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. Atenção: na atualização, `DISCOUNT`/`SALE` exigem valores inteiros e **rejeitam** decimais (diferente da criação, que trunca) — ver a nota do folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | — | Condições a alterar. Só as chaves enviadas dentro de `conditions` são modificadas — ver Notas sobre merge. |\n| `input.discountCode.description` | `String` | Não | — | Nova descrição. |\n| `input.discountCode.label` | `String` | Não | — | Novo rótulo. |\n\n### Retorno\n\n`UpdateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom após a atualização, com os mesmos campos retornados por `discountCode`. Ver Notas se `discountCodeId` não for válido. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação — ver Notas sobre o comportamento quando `discountCodeId` não é encontrado.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Um `calculation` com formato incompatível com o `method` informado retorna um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **Merge parcial, não substituição.** Só os campos enviados em `discountCode` são alterados; qualquer campo omitido mantém o valor atual. O mesmo vale dentro de `conditions`: enviar `conditions: { max: 100 }` altera só `max`, preservando `accountLimit`, `startDate`, etc. já configurados. Para limpar um campo opcional (ex.: `description`, `label` ou uma chave de `conditions`), envie-o explicitamente como `null`.\n- **Sem erro dedicado de \"não encontrado\".** Se `discountCodeId` não existir, pertencer a outra loja, já estiver removido (soft-delete) ou não for um cupom por código, a mutation **não lança um erro específico** — a atualização simplesmente não é aplicada. Sempre confira os campos em `discountCode` na resposta para confirmar que a alteração desejada realmente foi aplicada (por exemplo, comparando `enabled` ou os valores de `conditions` com o que você enviou)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"updateDiscountCode\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n }\n }\n}"},{"id":"e31113b3-41f7-4ff9-a30b-e88b7a9960ea","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateDiscountCode($input: UpdateDiscountCodeInput!) {\n updateDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n },\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## updateDiscountCode\n\n**Propósito:** Atualiza um cupom de desconto existente na sua loja.\n**Quando usar:** Para alterar dados de um cupom já criado (habilitar/desabilitar, mudar condições, trocar a forma de cálculo, etc.), sem recriá-lo. **É seguro reenviar a mesma chamada** (os mesmos campos, com os mesmos valores, produzem o mesmo resultado) — mas veja em Notas o comportamento quando o `discountCodeId` não é encontrado.\n**Autenticação:** `x-api-key` + `Authorization`. A atualização é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a atualizar. |\n| `input.discountCode` | `DiscountCodeInputUpdate` | Não | — | Campos a alterar. Só os campos enviados são modificados — ver Notas sobre merge. |\n| `input.discountCode.code` | `String` | Não | — | Novo código do cupom. |\n| `input.discountCode.enabled` | `Boolean` | Não | — | Habilita/desabilita o cupom. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Não | — | Não há motivo prático para alterar — este folder só trabalha com `CODE`. |\n| `input.discountCode.calculation` | `AWSJSON` | Não | — | Novo objeto de cálculo. Pode inclusive trocar o `method` por completo, desde que o objeto enviado corresponda ao formato exigido pelo novo `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. Atenção: na atualização, `DISCOUNT`/`SALE` exigem valores inteiros e **rejeitam** decimais (diferente da criação, que trunca) — ver a nota do folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | — | Condições a alterar. Só as chaves enviadas dentro de `conditions` são modificadas — ver Notas sobre merge. |\n| `input.discountCode.description` | `String` | Não | — | Nova descrição. |\n| `input.discountCode.label` | `String` | Não | — | Novo rótulo. |\n\n### Retorno\n\n`UpdateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom após a atualização, com os mesmos campos retornados por `discountCode`. Ver Notas se `discountCodeId` não for válido. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação — ver Notas sobre o comportamento quando `discountCodeId` não é encontrado.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Um `calculation` com formato incompatível com o `method` informado retorna um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **Merge parcial, não substituição.** Só os campos enviados em `discountCode` são alterados; qualquer campo omitido mantém o valor atual. O mesmo vale dentro de `conditions`: enviar `conditions: { max: 100 }` altera só `max`, preservando `accountLimit`, `startDate`, etc. já configurados. Para limpar um campo opcional (ex.: `description`, `label` ou uma chave de `conditions`), envie-o explicitamente como `null`.\n- **Sem erro dedicado de \"não encontrado\".** Se `discountCodeId` não existir, pertencer a outra loja, já estiver removido (soft-delete) ou não for um cupom por código, a mutation **não lança um erro específico** — a atualização simplesmente não é aplicada. Sempre confira os campos em `discountCode` na resposta para confirmar que a alteração desejada realmente foi aplicada (por exemplo, comparando `enabled` ou os valores de `conditions` com o que você enviou)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"baf7264b-eb4c-4e61-ac4e-a1fbde798003","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation UpdateDiscountCode($input: UpdateDiscountCodeInput!) {\n updateDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"calculation\": {},\n \"code\": \"Example_String\",\n \"conditions\": {\n \"accountLimit\": 10,\n \"recurrenceCycleLimit\": 10,\n \"endDate\": \"2025-01-15T10:00:00Z\",\n \"max\": 99.99,\n \"min\": 99.99,\n \"startDate\": \"2025-01-15T10:00:00Z\",\n \"redemptionLimit\": 10,\n \"productType\": \"ALL\",\n \"tags\": [\n \"Example_String\"\n ],\n \"audience\": [\n \"Example_String\"\n ],\n \"permissions\": [\n \"Example_String\"\n ],\n \"products\": [\n \"Example_String\"\n ]\n },\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true\n },\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## updateDiscountCode\n\n**Propósito:** Atualiza um cupom de desconto existente na sua loja.\n**Quando usar:** Para alterar dados de um cupom já criado (habilitar/desabilitar, mudar condições, trocar a forma de cálculo, etc.), sem recriá-lo. **É seguro reenviar a mesma chamada** (os mesmos campos, com os mesmos valores, produzem o mesmo resultado) — mas veja em Notas o comportamento quando o `discountCodeId` não é encontrado.\n**Autenticação:** `x-api-key` + `Authorization`. A atualização é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: UpdateDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------------------------- | ------------------------- | ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a atualizar. |\n| `input.discountCode` | `DiscountCodeInputUpdate` | Não | — | Campos a alterar. Só os campos enviados são modificados — ver Notas sobre merge. |\n| `input.discountCode.code` | `String` | Não | — | Novo código do cupom. |\n| `input.discountCode.enabled` | `Boolean` | Não | — | Habilita/desabilita o cupom. |\n| `input.discountCode.discountMethod` | `DiscountMethodEnum` | Não | — | Não há motivo prático para alterar — este folder só trabalha com `CODE`. |\n| `input.discountCode.calculation` | `AWSJSON` | Não | — | Novo objeto de cálculo. Pode inclusive trocar o `method` por completo, desde que o objeto enviado corresponda ao formato exigido pelo novo `method` — ver a seção **Tipos e enums compartilhados** na descrição deste folder. Atenção: na atualização, `DISCOUNT`/`SALE` exigem valores inteiros e **rejeitam** decimais (diferente da criação, que trunca) — ver a nota do folder. |\n| `input.discountCode.conditions` | `DiscountConditionsInput` | Não | — | Condições a alterar. Só as chaves enviadas dentro de `conditions` são modificadas — ver Notas sobre merge. |\n| `input.discountCode.description` | `String` | Não | — | Nova descrição. |\n| `input.discountCode.label` | `String` | Não | — | Novo rótulo. |\n\n### Retorno\n\n`UpdateDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom após a atualização, com os mesmos campos retornados por `discountCode`. Ver Notas se `discountCodeId` não for válido. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação — ver Notas sobre o comportamento quando `discountCodeId` não é encontrado.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. Um `calculation` com formato incompatível com o `method` informado retorna um erro de validação sem `extensions.code` estável — verifique sempre `message` nesse caso.\n\n### Notas\n\n- **Merge parcial, não substituição.** Só os campos enviados em `discountCode` são alterados; qualquer campo omitido mantém o valor atual. O mesmo vale dentro de `conditions`: enviar `conditions: { max: 100 }` altera só `max`, preservando `accountLimit`, `startDate`, etc. já configurados. Para limpar um campo opcional (ex.: `description`, `label` ou uma chave de `conditions`), envie-o explicitamente como `null`.\n- **Sem erro dedicado de \"não encontrado\".** Se `discountCodeId` não existir, pertencer a outra loja, já estiver removido (soft-delete) ou não for um cupom por código, a mutation **não lança um erro específico** — a atualização simplesmente não é aplicada. Sempre confira os campos em `discountCode` na resposta para confirmar que a alteração desejada realmente foi aplicada (por exemplo, comparando `enabled` ou os valores de `conditions` com o que você enviou)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"3cd759ae-74d0-5af7-81f5-42dd37d882bd"},{"name":"[Mutation] deleteDiscountCode","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns deleteDiscountCode data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"deleteDiscountCode\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"5f781ef7-738d-50b7-b2ed-2c000f1f2812","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteDiscountCode($input: DeleteDiscountCodeInput!) {\n deleteDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"deleteDiscountCode
\nPropósito: Remove um cupom de desconto da sua loja.\nQuando usar: Para desativar definitivamente um cupom que não deve mais existir (diferente de apenas desabilitá-lo via updateDiscountCode com enabled: false, que mantém o cupom visível e reativável). É uma remoção lógica (soft-delete) — o registro não é apagado, apenas marcado como removido. A operação é idempotente na prática: chamá-la novamente sobre um cupom já removido (ou um discountCodeId inválido) não lança erro, apenas retorna discountCode: null.\nAutenticação: x-api-key + Authorization. A remoção é restrita a cupons da sua loja autenticada — não há argumento de loja.
\nArgumentos
\nÚnico argumento: input: DeleteDiscountCodeInput!.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.clientMutationId | \nString | \nNão | \nnull | \nEcoado de volta na resposta, para você correlacionar chamadas. | \n
\n\ninput.discountCodeId | \nID! | \nSim | \n— | \nID do cupom a remover. | \n
\n\n
\n
Retorno
\nDeleteDiscountCodePayload:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nclientMutationId | \nString | \nO mesmo valor enviado no argumento, se enviado. | \n
\n\ndiscountCode | \nDiscount | \nO cupom como estava imediatamente antes da remoção (ver Notas). null se discountCodeId não existir, já estiver removido, pertencer a outra loja, ou não for um cupom por código. | \n
\n\n
\n
Erros
\nNenhum código de erro de negócio conhecido para esta operação — falhas (ID inválido, já removido, etc.) retornam discountCode: null em vez de um erro (ver Notas).
\n\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Soft-delete. O cupom não é apagado — apenas marcado como removido. A partir daí, ele deixa de aparecer em
discountCodes e discountCode passa a retornar DISCOUNT_CODE_NOT_FOUND_ERROR para o mesmo ID. \n- O
discountCode retornado reflete o estado anterior à remoção. Note que o campo enabled (e os demais campos) na resposta mostram o cupom como estava um instante antes de ser marcado como removido, não o estado \"já removido\" — não existe um campo de retorno que indique explicitamente \"isto foi removido agora\". \n- Idempotente na prática, sem erro dedicado de \"não encontrado\". Chamar esta mutation para um
discountCodeId inexistente, de outra loja, ou já removido não lança erro — a resposta simplesmente traz discountCode: null. Trate null como \"nada foi removido nesta chamada\" (já estava removido, ou nunca existiu na sua loja), não como falha. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7c1774cd-eebf-42ce-a0ba-f7739c667234","name":"200 - deleteDiscountCode","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteDiscountCode($input: DeleteDiscountCodeInput!) {\n deleteDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## deleteDiscountCode\n\n**Propósito:** Remove um cupom de desconto da sua loja.\n**Quando usar:** Para desativar definitivamente um cupom que não deve mais existir (diferente de apenas desabilitá-lo via `updateDiscountCode` com `enabled: false`, que mantém o cupom visível e reativável). **É uma remoção lógica (soft-delete)** — o registro não é apagado, apenas marcado como removido. A operação é **idempotente na prática**: chamá-la novamente sobre um cupom já removido (ou um `discountCodeId` inválido) não lança erro, apenas retorna `discountCode: null`.\n**Autenticação:** `x-api-key` + `Authorization`. A remoção é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: DeleteDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------- | ----------- | ------- | -------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a remover. |\n\n### Retorno\n\n`DeleteDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom **como estava imediatamente antes da remoção** (ver Notas). `null` se `discountCodeId` não existir, já estiver removido, pertencer a outra loja, ou não for um cupom por código. |\n\n### Erros\n\nNenhum código de erro de negócio conhecido para esta operação — falhas (ID inválido, já removido, etc.) retornam `discountCode: null` em vez de um erro (ver Notas).\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Soft-delete.** O cupom não é apagado — apenas marcado como removido. A partir daí, ele deixa de aparecer em `discountCodes` e `discountCode` passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **O `discountCode` retornado reflete o estado anterior à remoção.** Note que o campo `enabled` (e os demais campos) na resposta mostram o cupom como estava um instante antes de ser marcado como removido, não o estado \"já removido\" — não existe um campo de retorno que indique explicitamente \"isto foi removido agora\".\n- **Idempotente na prática, sem erro dedicado de \"não encontrado\".** Chamar esta mutation para um `discountCodeId` inexistente, de outra loja, ou já removido não lança erro — a resposta simplesmente traz `discountCode: null`. Trate `null` como \"nada foi removido nesta chamada\" (já estava removido, ou nunca existiu na sua loja), não como falha."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"deleteDiscountCode\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCode\": {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n }\n }\n}"},{"id":"a41ce362-55a1-4fe8-aa2c-80f338efac8b","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteDiscountCode($input: DeleteDiscountCodeInput!) {\n deleteDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## deleteDiscountCode\n\n**Propósito:** Remove um cupom de desconto da sua loja.\n**Quando usar:** Para desativar definitivamente um cupom que não deve mais existir (diferente de apenas desabilitá-lo via `updateDiscountCode` com `enabled: false`, que mantém o cupom visível e reativável). **É uma remoção lógica (soft-delete)** — o registro não é apagado, apenas marcado como removido. A operação é **idempotente na prática**: chamá-la novamente sobre um cupom já removido (ou um `discountCodeId` inválido) não lança erro, apenas retorna `discountCode: null`.\n**Autenticação:** `x-api-key` + `Authorization`. A remoção é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: DeleteDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------- | ----------- | ------- | -------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a remover. |\n\n### Retorno\n\n`DeleteDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom **como estava imediatamente antes da remoção** (ver Notas). `null` se `discountCodeId` não existir, já estiver removido, pertencer a outra loja, ou não for um cupom por código. |\n\n### Erros\n\nNenhum código de erro de negócio conhecido para esta operação — falhas (ID inválido, já removido, etc.) retornam `discountCode: null` em vez de um erro (ver Notas).\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Soft-delete.** O cupom não é apagado — apenas marcado como removido. A partir daí, ele deixa de aparecer em `discountCodes` e `discountCode` passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **O `discountCode` retornado reflete o estado anterior à remoção.** Note que o campo `enabled` (e os demais campos) na resposta mostram o cupom como estava um instante antes de ser marcado como removido, não o estado \"já removido\" — não existe um campo de retorno que indique explicitamente \"isto foi removido agora\".\n- **Idempotente na prática, sem erro dedicado de \"não encontrado\".** Chamar esta mutation para um `discountCodeId` inexistente, de outra loja, ou já removido não lança erro — a resposta simplesmente traz `discountCode: null`. Trate `null` como \"nada foi removido nesta chamada\" (já estava removido, ou nunca existiu na sua loja), não como falha."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"691e054b-94a7-46de-9427-f2efff848701","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation DeleteDiscountCode($input: DeleteDiscountCodeInput!) {\n deleteDiscountCode(input: $input) {\n clientMutationId\n discountCode {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"discountCodeId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## deleteDiscountCode\n\n**Propósito:** Remove um cupom de desconto da sua loja.\n**Quando usar:** Para desativar definitivamente um cupom que não deve mais existir (diferente de apenas desabilitá-lo via `updateDiscountCode` com `enabled: false`, que mantém o cupom visível e reativável). **É uma remoção lógica (soft-delete)** — o registro não é apagado, apenas marcado como removido. A operação é **idempotente na prática**: chamá-la novamente sobre um cupom já removido (ou um `discountCodeId` inválido) não lança erro, apenas retorna `discountCode: null`.\n**Autenticação:** `x-api-key` + `Authorization`. A remoção é restrita a cupons da sua loja autenticada — não há argumento de loja.\n\n### Argumentos\n\nÚnico argumento: `input: DeleteDiscountCodeInput!`.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------- | ----------- | ------- | -------------------------------------------------------------- |\n| `input.clientMutationId` | `String` | Não | `null` | Ecoado de volta na resposta, para você correlacionar chamadas. |\n| `input.discountCodeId` | `ID!` | Sim | — | ID do cupom a remover. |\n\n### Retorno\n\n`DeleteDiscountCodePayload`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `clientMutationId` | `String` | O mesmo valor enviado no argumento, se enviado. |\n| `discountCode` | `Discount` | O cupom **como estava imediatamente antes da remoção** (ver Notas). `null` se `discountCodeId` não existir, já estiver removido, pertencer a outra loja, ou não for um cupom por código. |\n\n### Erros\n\nNenhum código de erro de negócio conhecido para esta operação — falhas (ID inválido, já removido, etc.) retornam `discountCode: null` em vez de um erro (ver Notas).\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Soft-delete.** O cupom não é apagado — apenas marcado como removido. A partir daí, ele deixa de aparecer em `discountCodes` e `discountCode` passa a retornar `DISCOUNT_CODE_NOT_FOUND_ERROR` para o mesmo ID.\n- **O `discountCode` retornado reflete o estado anterior à remoção.** Note que o campo `enabled` (e os demais campos) na resposta mostram o cupom como estava um instante antes de ser marcado como removido, não o estado \"já removido\" — não existe um campo de retorno que indique explicitamente \"isto foi removido agora\".\n- **Idempotente na prática, sem erro dedicado de \"não encontrado\".** Chamar esta mutation para um `discountCodeId` inexistente, de outra loja, ou já removido não lança erro — a resposta simplesmente traz `discountCode: null`. Trate `null` como \"nada foi removido nesta chamada\" (já estava removido, ou nunca existiu na sua loja), não como falha."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"5f781ef7-738d-50b7-b2ed-2c000f1f2812"}],"id":"2bac1ff8-3721-4c05-8b95-da0c833081b9","_postman_id":"2bac1ff8-3721-4c05-8b95-da0c833081b9","description":""}],"id":"b57e7408-7a8e-480e-97c0-6b7c32bb0e05","description":"Cupons de Desconto
\nGerencia os cupons de desconto (discount codes) da sua loja — consulta individual, listagem com filtros, criação, atualização e remoção. Cobre as operações discountCode, discountCodes, createDiscountCode, updateDiscountCode e deleteDiscountCode. Este folder trabalha apenas com descontos ativados por código (o comprador digita o cupom); descontos automáticos de loja (sem código) não aparecem nem podem ser gerenciados por aqui.
\nTipos e enums compartilhados
\nDiscountCalculationMethodEnum — como o desconto é calculado
\ncalculation é um objeto JSON (scalar AWSJSON) cujo campo method define a forma de cálculo e quais outros campos o objeto aceita. Só os sete métodos abaixo se aplicam a cupons por código; envie exatamente os campos indicados para o method escolhido.
\n\n\n\nmethod | \nCampos de calculation (além de method) | \nDescrição | \n
\n\n\n\nDISCOUNT | \namountByProductType: { RECURRING, NON_RECURRING } (inteiros) | \nDesconta um percentual do carrinho, com percentuais distintos por tipo de produto. | \n
\n\nSALE | \namountByProductType: { RECURRING, NON_RECURRING } (inteiros) | \nDesconta um valor fixo por item, com valores distintos por tipo de produto. | \n
\n\nCREDIT_OFF_BY_PRODUCT_TYPE | \namountByProductType: { RECURRING, NON_RECURRING } (decimais) | \nDesconta um valor fixo do carrinho (não por item), com valores distintos por tipo. | \n
\n\nCREDIT_OFF_FLAT | \namount (decimal, opcional) | \nDesconta um valor fixo do carrinho, único, sem diferenciar tipo de produto. | \n
\n\nSHIPPING | \nfulfillmentOptionNames: [String] | \nConcede frete grátis para os métodos de envio cujo nome esteja na lista. | \n
\n\nSUBSCRIPTION | \n(nenhum) | \nHabilita planos de assinatura não padrão da Unbox. | \n
\n\nDOUBLE_PRODUCT_ITEMS | \nmaxUseLimitPerItem (inteiro), targetProducts | \nDuplica um produto-alvo no carrinho; a cópia entra grátis (ver detalhes abaixo). | \n
\n\n
\n
Os valores FREE_ITEM_BY_TIER e DISCOUNT_BY_PAYMENT_METHOD também existem no enum, mas pertencem a descontos automáticos de loja, nunca a cupons por código. Um cupom criado por createDiscountCode nunca terá um desses dois métodos, e filtrar discountCodes por eles não retorna resultados.
\namountByProductType sempre usa as chaves RECURRING/NON_RECURRING de DiscountProductTypeEnum (o valor ALL não se aplica a um cálculo diferenciado por tipo).
\nValores inteiros vs. decimais. Para DISCOUNT e SALE, os valores de amountByProductType devem ser inteiros: na criação (createDiscountCode), valores com casas decimais são truncados silenciosamente; na atualização (updateDiscountCode), valores não inteiros são rejeitados com erro de validação. Para CREDIT_OFF_BY_PRODUCT_TYPE e CREDIT_OFF_FLAT, decimais são aceitos e arredondados para 3 casas na criação (a atualização não reprocessa o valor).
\nDOUBLE_PRODUCT_ITEMS. A cópia adicionada ao carrinho entra grátis — o preço cheio do item duplicado é descontado, e não há campo para configurar um desconto parcial. Campos:
\n\nmaxUseLimitPerItem (inteiro): quantas cópias com desconto podem ser adicionadas; 0 significa sem limite.targetProducts: { includeAllProducts: Boolean, productsAllowList: [{ productId, productErpCode }] }: quais produtos ativam o desconto. productId e productErpCode são strings opcionais — informe um dos dois por produto-alvo. Use includeAllProducts: true para mirar todo o catálogo (nesse caso productsAllowList é dispensável).
\nEmbora a validação de escrita não exija maxUseLimitPerItem nem targetProducts, maxUseLimitPerItem é um campo não nulo na leitura; sempre informe-o ao criar para evitar respostas inconsistentes em consultas posteriores.
\nExemplos de calculation por método
\nEnvie calculation como um objeto JSON conforme os exemplos abaixo (é o scalar AWSJSON; caso o seu cliente GraphQL exija, AWSJSON também pode ser transmitido como uma string JSON escapada com o mesmo conteúdo).
\n{\n \"method\": \"DISCOUNT\",\n \"amountByProductType\": { \"RECURRING\": 10, \"NON_RECURRING\": 15 }\n}\n
\n{\n \"method\": \"SALE\",\n \"amountByProductType\": { \"RECURRING\": 500, \"NON_RECURRING\": 1000 }\n}\n
\n{\n \"method\": \"CREDIT_OFF_BY_PRODUCT_TYPE\",\n \"amountByProductType\": { \"RECURRING\": 5.5, \"NON_RECURRING\": 9.9 }\n}\n
\n{ \"method\": \"CREDIT_OFF_FLAT\", \"amount\": 25.9 }\n
\n{ \"method\": \"SHIPPING\", \"fulfillmentOptionNames\": [\"PAC\", \"SEDEX\"] }\n
\n{ \"method\": \"SUBSCRIPTION\" }\n
\n{\n \"method\": \"DOUBLE_PRODUCT_ITEMS\",\n \"maxUseLimitPerItem\": 1,\n \"targetProducts\": {\n \"includeAllProducts\": false,\n \"productsAllowList\": [{ \"productId\": \"abc123\" }]\n }\n}\n
\nDiscountProductTypeEnum — a quais itens o cupom se aplica
\n\n\n\n| Valor | \nDescrição | \n
\n\n\n\nALL | \nTodos os produtos do carrinho são elegíveis. | \n
\n\nRECURRING | \nSomente produtos de assinatura/recorrentes são elegíveis. | \n
\n\nNON_RECURRING | \nSomente produtos avulsos (não recorrentes) são elegíveis. | \n
\n\n
\n
Usado tanto em conditions.productType (uma condição do cupom) quanto como chave de amountByProductType dentro de calculation (nesse caso sem o valor ALL, que não se aplica a um cálculo diferenciado por tipo).
\nconditions — condições de aplicação do cupom
\nCampos de DiscountConditionsInput (entrada) e DiscountConditions (retorno) — mesma estrutura nos dois sentidos:
\n\n\n\n| Campo | \nTipo | \nDescrição | \n
\n\n\n\naccountLimit | \nInt | \nQuantas vezes uma mesma conta de comprador pode usar este cupom. | \n
\n\nredemptionLimit | \nInt | \nQuantas vezes o cupom pode ser resgatado no total. 0 significa sem limite (uso ilimitado); um valor como 100 permite os 100 primeiros usos. | \n
\n\nrecurrenceCycleLimit | \nInt | \nQuantos ciclos de um pedido recorrente podem usar este cupom. | \n
\n\nstartDate | \nAWSDateTime | \nData/hora a partir da qual o cupom passa a valer. | \n
\n\nendDate | \nAWSDateTime | \nData/hora a partir da qual o cupom deixa de valer. | \n
\n\nmax | \nFloat | \nValor máximo do pedido para o cupom poder ser aplicado. | \n
\n\nmin | \nFloat | \nValor mínimo do pedido para o cupom poder ser aplicado. | \n
\n\nproductType | \nDiscountProductTypeEnum | \nTipo de produto elegível (ver enum acima). | \n
\n\ntags, audience, permissions, products | \n[String] | \nCondições legadas, mantidas por compatibilidade. Evite usar em cupons novos — não há garantia de suporte continuado. | \n
\n\n
\n
DiscountCodesSortByField — ordenação de discountCodes
\n\n\n\n| Valor | \nOrdena por | \n
\n\n\n\ncreatedAt (default) | \nData de criação do cupom. | \n
\n\nupdatedAt | \nData da última atualização. | \n
\n\ncode | \nO código do cupom, alfabeticamente. | \n
\n\ncalculationMethod | \nO method de calculation. | \n
\n\nstartDate / endDate | \nAs datas de início/fim de vigência (conditions.startDate/endDate). | \n
\n\namountOfRedemptions | \nQuantas vezes o cupom já foi resgatado — este valor não é exposto em nenhum campo do retorno, mas pode ser usado para ordenar. | \n
\n\n
\n
Regras de negócio
\n\n- Só cupons por código. Todas as operações deste folder ignoram descontos automáticos de loja:
discountCode e discountCodes nunca retornam um desconto que não seja do tipo código, e createDiscountCode sempre cria um cupom por código. \n- Soft-delete.
deleteDiscountCode não apaga o registro — ele marca o cupom como removido. A partir daí, o cupom deixa de aparecer em discountCodes e discountCode passa a se comportar como se ele não existisse (erro de não encontrado). \n- Duplicidade de
code é verificada por vigência, não apenas por existência. Ao criar um cupom, a Unbox só bloqueia com erro de duplicidade se já existir, na sua loja, um cupom com o mesmo code (comparação sem diferenciar maiúsculas/minúsculas, e ignorando espaços nas pontas) que esteja habilitado, não removido e dentro do período de vigência (conditions.startDate/endDate, quando definidos). Reaproveitar o code de um cupom expirado, ainda não iniciado, ou desabilitado é permitido — a Unbox não impede a criação do novo cupom nesse caso, mesmo que o cupom antigo continue existindo. \nupdateDiscountCode faz merge, não substituição. Só os campos enviados em discountCode são alterados; qualquer campo omitido mantém o valor atual. Isso vale inclusive para conditions: você pode enviar conditions: { max: 100 } para alterar apenas o valor máximo do pedido sem afetar accountLimit, startDate, etc. Para limpar um campo opcional (ex.: description, label ou uma chave de conditions), envie-o explicitamente como null.- Paginação Relay (
discountCodes): use first/after para avançar página a página, ou last/before para voltar. offset pula os N primeiros resultados e é usado em conjunto com first. nodes traz a lista direta; edges traz cada item envolvido em um cursor (use quando for paginar); pageInfo informa se há mais páginas; totalCount é o total de cupons que casam com os filtros, independente da página. \n
\n","_postman_id":"b57e7408-7a8e-480e-97c0-6b7c32bb0e05"},{"name":"External Checkout","item":[{"name":"Mutation","item":[{"name":"[Mutation] createExternalCheckout","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns createExternalCheckout data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"createExternalCheckout\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"6949a62e-8c9e-5728-9ceb-119ac9f5f90d","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateExternalCheckout($input: ExternalCheckoutInput!) {\n createExternalCheckout(input: $input) {\n checkoutUrl\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"successCallbackURL\": \"https://exemplo.com\",\n \"constraints\": {\n \"buyerTypes\": [\n \"COMPANY\"\n ],\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"orderTotal\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"orderSummary\": [\n {\n \"description\": \"Example_String\",\n \"amount\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n }\n ],\n \"items\": [\n {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"image\": {\n \"url\": \"https://exemplo.com\",\n \"altText\": \"Example_String\"\n },\n \"parcel\": {\n \"weight\": 99.99,\n \"height\": 99.99,\n \"width\": 99.99,\n \"length\": 99.99\n }\n }\n ],\n \"customer\": {\n \"firstName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"lastName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address1\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address2\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"number\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"neighborhood\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"city\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"region\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"postal\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"phone\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"taxPayerId\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"email\": {\n \"value\": 99.99,\n \"editable\": true\n }\n }\n }\n}"}},"url":"{{base_url}}","description":"Creates a payment link from a 3Cliques Marketplace cart returning a checkout url
\nType: ✏️ Mutation
\nParameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\ninput | \nExternalCheckoutInput! | \n- | \n
\n\n
\n
Returns
\nExternalCheckoutPayload!
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b702b2f-3442-4a29-a4e3-084d6237b318","name":"200 - createExternalCheckout","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateExternalCheckout($input: ExternalCheckoutInput!) {\n createExternalCheckout(input: $input) {\n checkoutUrl\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"successCallbackURL\": \"https://exemplo.com\",\n \"constraints\": {\n \"buyerTypes\": [\n \"COMPANY\"\n ],\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"orderTotal\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"orderSummary\": [\n {\n \"description\": \"Example_String\",\n \"amount\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n }\n ],\n \"items\": [\n {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"image\": {\n \"url\": \"https://exemplo.com\",\n \"altText\": \"Example_String\"\n },\n \"parcel\": {\n \"weight\": 99.99,\n \"height\": 99.99,\n \"width\": 99.99,\n \"length\": 99.99\n }\n }\n ],\n \"customer\": {\n \"firstName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"lastName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address1\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address2\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"number\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"neighborhood\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"city\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"region\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"postal\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"phone\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"taxPayerId\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"email\": {\n \"value\": 99.99,\n \"editable\": true\n }\n }\n }\n}"}},"url":"{{base_url}}","description":"Creates a payment link from a 3Cliques Marketplace cart returning a checkout url\n\n**Type:** ✏️ Mutation\n\n## Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| `input` | `ExternalCheckoutInput!` | - |\n\n## Returns\n\n`ExternalCheckoutPayload!`\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"createExternalCheckout\": {\n \"checkoutUrl\": \"https://exemplo.com\",\n \"paymentLink\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"description\": \"Example_String\",\n \"ordersCount\": 10,\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n }\n }\n }\n}"},{"id":"9905a08a-99ae-4b56-9cee-ba3db931f763","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateExternalCheckout($input: ExternalCheckoutInput!) {\n createExternalCheckout(input: $input) {\n checkoutUrl\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"successCallbackURL\": \"https://exemplo.com\",\n \"constraints\": {\n \"buyerTypes\": [\n \"COMPANY\"\n ],\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"orderTotal\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"orderSummary\": [\n {\n \"description\": \"Example_String\",\n \"amount\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n }\n ],\n \"items\": [\n {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"image\": {\n \"url\": \"https://exemplo.com\",\n \"altText\": \"Example_String\"\n },\n \"parcel\": {\n \"weight\": 99.99,\n \"height\": 99.99,\n \"width\": 99.99,\n \"length\": 99.99\n }\n }\n ],\n \"customer\": {\n \"firstName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"lastName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address1\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address2\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"number\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"neighborhood\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"city\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"region\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"postal\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"phone\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"taxPayerId\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"email\": {\n \"value\": 99.99,\n \"editable\": true\n }\n }\n }\n}"}},"url":"{{base_url}}","description":"Creates a payment link from a 3Cliques Marketplace cart returning a checkout url\n\n**Type:** ✏️ Mutation\n\n## Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| `input` | `ExternalCheckoutInput!` | - |\n\n## Returns\n\n`ExternalCheckoutPayload!`\n"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"ebd649ac-3a69-4fa5-88c1-c312f9e8c08c","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation CreateExternalCheckout($input: ExternalCheckoutInput!) {\n createExternalCheckout(input: $input) {\n checkoutUrl\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n }\n}","variables":"{\n \"input\": {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"successCallbackURL\": \"https://exemplo.com\",\n \"constraints\": {\n \"buyerTypes\": [\n \"COMPANY\"\n ],\n \"usageLimit\": 10,\n \"expirationDate\": \"2025-01-15T10:00:00Z\"\n },\n \"orderTotal\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"orderSummary\": [\n {\n \"description\": \"Example_String\",\n \"amount\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n }\n }\n ],\n \"items\": [\n {\n \"title\": \"Example_String\",\n \"description\": \"Example_String\",\n \"quantity\": 1,\n \"price\": {\n \"amount\": 99.99,\n \"currencyCode\": \"BRL\"\n },\n \"image\": {\n \"url\": \"https://exemplo.com\",\n \"altText\": \"Example_String\"\n },\n \"parcel\": {\n \"weight\": 99.99,\n \"height\": 99.99,\n \"width\": 99.99,\n \"length\": 99.99\n }\n }\n ],\n \"customer\": {\n \"firstName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"lastName\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address1\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"address2\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"number\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"neighborhood\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"city\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"region\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"postal\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"phone\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"taxPayerId\": {\n \"value\": 99.99,\n \"editable\": true\n },\n \"email\": {\n \"value\": 99.99,\n \"editable\": true\n }\n }\n }\n}"}},"url":"{{base_url}}","description":"Creates a payment link from a 3Cliques Marketplace cart returning a checkout url\n\n**Type:** ✏️ Mutation\n\n## Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| `input` | `ExternalCheckoutInput!` | - |\n\n## Returns\n\n`ExternalCheckoutPayload!`\n"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"6949a62e-8c9e-5728-9ceb-119ac9f5f90d"}],"id":"6baef9ab-a9d9-4f8c-bfb5-8a62e58ea10b","_postman_id":"6baef9ab-a9d9-4f8c-bfb5-8a62e58ea10b","description":""}],"id":"0ada30da-adb1-47e1-99a9-a167416dfcb4","description":"External Checkout
\nFluxo para gerar um checkout hospedado pela Unbox a partir de um carrinho montado fora da plataforma (por exemplo, em um marketplace ou app do parceiro). Você envia os itens, o valor total e as regras do link; a Unbox devolve uma URL de pagamento pronta para o comprador finalizar a compra. É o ponto de entrada operacional mais comum desta API — normalmente a primeira chamada de negócio feita logo após signIn.
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores/Campos | \nDescrição | \n
\n\n\n\nBuyerTypesEnum | \nCOMPANY, NATURAL_PERSON | \nUsado em constraints.buyerTypes para restringir quem pode concluir o checkout: apenas pessoa jurídica, apenas pessoa física, ou ambos (lista com os dois valores). | \n
\n\n
\n
Valores monetários (MoneyInput) sempre em centavos. Em toda esta operação — orderTotal.amount, items[].price.amount e orderSummary[].amount.amount — o campo amount é um inteiro em centavos (ex.: R$ 149,90 é enviado como 14990). Não envie valores decimais.
\nRegras de negócio
\n\n- A loja precisa ter o canal de checkout externo habilitado. Se não estiver, a operação falha com
INVALID_CHECKOUT_PROVIDER_ERROR. Esse é um pré-requisito de configuração da loja, não algo controlado por argumento — fale com seu contato Unbox para habilitar antes de integrar. \n- Cada chamada gera um novo link de pagamento. Não há deduplicação por
externalId: reenviar a mesma requisição (ex.: em um retry) cria um segundo link de checkout distinto. Trate seu lado da integração como responsável por evitar reenvios indevidos. \n- Acompanhamento pós-criação é feito fora deste folder. Use
paymentLink/paymentLinks para consultar o status do link retornado, e orders/orderByReferenceId para acompanhar o pedido depois que o comprador finalizar o pagamento. \n
\n","_postman_id":"0ada30da-adb1-47e1-99a9-a167416dfcb4"},{"name":"Inventory Simple","item":[{"name":"Query","item":[{"name":"[Query] simpleInventory","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns simpleInventory data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"simpleInventory\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"simpleInventory returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.simpleInventory;"," "," if (data !== null) {"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.canBackorder !== undefined && data.canBackorder !== null) {"," pm.expect(typeof data.canBackorder).to.equal(\"boolean\");"," }"," if (data.inventoryInStock !== undefined && data.inventoryInStock !== null) {"," pm.expect(typeof data.inventoryInStock).to.equal(\"number\");"," }"," if (data.inventoryReserved !== undefined && data.inventoryReserved !== null) {"," pm.expect(typeof data.inventoryReserved).to.equal(\"number\");"," }"," if (data.isEnabled !== undefined && data.isEnabled !== null) {"," pm.expect(typeof data.isEnabled).to.equal(\"boolean\");"," }"," if (data.lowInventoryWarningThreshold !== undefined && data.lowInventoryWarningThreshold !== null) {"," pm.expect(typeof data.lowInventoryWarningThreshold).to.equal(\"number\");"," }"," pm.expect(data).to.have.property(\"productConfiguration\");"," if (data.productConfiguration !== undefined && data.productConfiguration !== null) {"," pm.expect(data.productConfiguration).to.be.an(\"object\");"," }"," }","});"]}}],"id":"be44f726-6c83-55f4-b62c-b525234a85e2","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query SimpleInventory($productConfiguration: ProductConfigurationInput!) {\n simpleInventory(productConfiguration: $productConfiguration) {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n}","variables":"{\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"simpleInventory
\nPropósito: Consulta o saldo de estoque de uma configuração de produto (produto + variante) na sua loja.\nQuando usar: Antes de exibir disponibilidade ou permitir a venda de um item, para saber a quantidade disponível e se o produto aceita venda além do estoque (backorder).\nAutenticação: x-api-key + Authorization. O shopId é injetado a partir do seu token — não envie esse argumento.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nproductConfiguration | \nProductConfigurationInput! | \nSim | \n— | \nIdentifica o produto e a variante consultados. | \n
\n\nproductConfiguration.productId | \nID! | \nSim | \n— | \nID do produto. | \n
\n\nproductConfiguration.productVariantId | \nID! | \nSim | \n— | \nID da variante do produto. | \n
\n\n
\n
Retorno
\nRetorna null se o controle de estoque nunca foi inicializado para essa configuração de produto (ver Notas). Quando existe, SimpleInventoryInfo:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID | \nIdentificador do registro de estoque. | \n
\n\ninventoryInStock | \nInt | \nQuantidade em estoque. | \n
\n\ninventoryReserved | \nInt | \nQuantidade reservada por pedidos em andamento. Calculada automaticamente pela Unbox conforme pedidos são criados/confirmados/cancelados — não é um valor que você define. | \n
\n\ncanBackorder | \nBoolean | \nSe true, a venda é permitida mesmo quando a quantidade disponível (inventoryInStock - inventoryReserved) chega a zero ou fica negativa. | \n
\n\nisEnabled | \nBoolean | \nSe false, o controle de estoque está desativado para esta configuração de produto — a Unbox não usa estes valores para bloquear vendas (os números continuam sendo atualizados, mas não são aplicados como limite). | \n
\n\nlowInventoryWarningThreshold | \nInt | \nLimiar de \"estoque baixo\": o produto é considerado com estoque baixo quando a quantidade disponível fica igual ou menor que este valor. | \n
\n\nproductConfiguration.productId | \nID | \nProduto retornado. | \n
\n\nproductConfiguration.productVariantId | \nID | \nVariante retornada. | \n
\n\nproductConfiguration.productErpCode | \nString | \nCódigo do produto no seu ERP, se cadastrado. | \n
\n\nproductConfiguration.variantErpCode | \nString | \nCódigo da variante no seu ERP, se cadastrado. | \n
\n\n
\n
Erros
\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (access_token ausente ou expirado) seguem o padrão geral descrito na Overview.
\n\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\nnull não é erro. Se o estoque nunca foi configurado para aquela combinação de produto e variante, a consulta retorna null em vez de um objeto com valores zerados. Trate isso como \"sem dado configurado\", não como estoque zero.inventoryReserved é somente leitura nesta operação. O valor reflete pedidos em andamento e é recalculado automaticamente pela Unbox — não há argumento nesta query para alterá-lo.- Disponibilidade real =
inventoryInStock - inventoryReserved. Combine com canBackorder na sua lógica de exibição: mesmo com disponibilidade zero ou negativa, a venda pode ainda ser permitida se canBackorder for true. Use lowInventoryWarningThreshold para sinalizar \"estoque baixo\" ao comprador antes de chegar a zero. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6ebf560d-7bad-4e42-bf80-6f5a6d1868b3","name":"200 - simpleInventory","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query SimpleInventory($productConfiguration: ProductConfigurationInput!) {\n simpleInventory(productConfiguration: $productConfiguration) {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n}","variables":"{\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## simpleInventory\n\n**Propósito:** Consulta o saldo de estoque de uma configuração de produto (produto + variante) na sua loja.\n**Quando usar:** Antes de exibir disponibilidade ou permitir a venda de um item, para saber a quantidade disponível e se o produto aceita venda além do estoque (backorder).\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------------- | ---------------------------- | ----------- | ------- | ---------------------------------------------- |\n| `productConfiguration` | `ProductConfigurationInput!` | Sim | — | Identifica o produto e a variante consultados. |\n| `productConfiguration.productId` | `ID!` | Sim | — | ID do produto. |\n| `productConfiguration.productVariantId` | `ID!` | Sim | — | ID da variante do produto. |\n\n### Retorno\n\nRetorna `null` se o controle de estoque nunca foi inicializado para essa configuração de produto (ver Notas). Quando existe, `SimpleInventoryInfo`:\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID` | Identificador do registro de estoque. |\n| `inventoryInStock` | `Int` | Quantidade em estoque. |\n| `inventoryReserved` | `Int` | Quantidade reservada por pedidos em andamento. Calculada automaticamente pela Unbox conforme pedidos são criados/confirmados/cancelados — não é um valor que você define. |\n| `canBackorder` | `Boolean` | Se `true`, a venda é permitida mesmo quando a quantidade disponível (`inventoryInStock - inventoryReserved`) chega a zero ou fica negativa. |\n| `isEnabled` | `Boolean` | Se `false`, o controle de estoque está desativado para esta configuração de produto — a Unbox não usa estes valores para bloquear vendas (os números continuam sendo atualizados, mas não são aplicados como limite). |\n| `lowInventoryWarningThreshold` | `Int` | Limiar de \"estoque baixo\": o produto é considerado com estoque baixo quando a quantidade disponível fica igual ou menor que este valor. |\n| `productConfiguration.productId` | `ID` | Produto retornado. |\n| `productConfiguration.productVariantId` | `ID` | Variante retornada. |\n| `productConfiguration.productErpCode` | `String` | Código do produto no seu ERP, se cadastrado. |\n| `productConfiguration.variantErpCode` | `String` | Código da variante no seu ERP, se cadastrado. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **`null` não é erro.** Se o estoque nunca foi configurado para aquela combinação de produto e variante, a consulta retorna `null` em vez de um objeto com valores zerados. Trate isso como \"sem dado configurado\", não como estoque zero.\n- **`inventoryReserved` é somente leitura nesta operação.** O valor reflete pedidos em andamento e é recalculado automaticamente pela Unbox — não há argumento nesta query para alterá-lo.\n- **Disponibilidade real = `inventoryInStock - inventoryReserved`.** Combine com `canBackorder` na sua lógica de exibição: mesmo com disponibilidade zero ou negativa, a venda pode ainda ser permitida se `canBackorder` for `true`. Use `lowInventoryWarningThreshold` para sinalizar \"estoque baixo\" ao comprador antes de chegar a zero."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"simpleInventory\": {\n \"_id\": \"Example_ID\",\n \"canBackorder\": true,\n \"inventoryInStock\": 10,\n \"inventoryReserved\": 10,\n \"isEnabled\": true,\n \"lowInventoryWarningThreshold\": 10,\n \"productConfiguration\": {\n \"productId\": \"Example_ID\",\n \"productVariantId\": \"Example_ID\",\n \"productErpCode\": \"Example_String\",\n \"variantErpCode\": \"Example_String\"\n }\n }\n }\n}"},{"id":"0d93b650-9b01-4048-9cce-14d48da0d668","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query SimpleInventory($productConfiguration: ProductConfigurationInput!) {\n simpleInventory(productConfiguration: $productConfiguration) {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n}","variables":"{\n \"productConfiguration\": {\n \"productId\": \"{{productId}}\",\n \"productVariantId\": \"Example_ID\"\n }\n}"}},"url":"{{base_url}}","description":"## simpleInventory\n\n**Propósito:** Consulta o saldo de estoque de uma configuração de produto (produto + variante) na sua loja.\n**Quando usar:** Antes de exibir disponibilidade ou permitir a venda de um item, para saber a quantidade disponível e se o produto aceita venda além do estoque (backorder).\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| --------------------------------------- | ---------------------------- | ----------- | ------- | ---------------------------------------------- |\n| `productConfiguration` | `ProductConfigurationInput!` | Sim | — | Identifica o produto e a variante consultados. |\n| `productConfiguration.productId` | `ID!` | Sim | — | ID do produto. |\n| `productConfiguration.productVariantId` | `ID!` | Sim | — | ID da variante do produto. |\n\n### Retorno\n\nRetorna `null` se o controle de estoque nunca foi inicializado para essa configuração de produto (ver Notas). Quando existe, `SimpleInventoryInfo`:\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID` | Identificador do registro de estoque. |\n| `inventoryInStock` | `Int` | Quantidade em estoque. |\n| `inventoryReserved` | `Int` | Quantidade reservada por pedidos em andamento. Calculada automaticamente pela Unbox conforme pedidos são criados/confirmados/cancelados — não é um valor que você define. |\n| `canBackorder` | `Boolean` | Se `true`, a venda é permitida mesmo quando a quantidade disponível (`inventoryInStock - inventoryReserved`) chega a zero ou fica negativa. |\n| `isEnabled` | `Boolean` | Se `false`, o controle de estoque está desativado para esta configuração de produto — a Unbox não usa estes valores para bloquear vendas (os números continuam sendo atualizados, mas não são aplicados como limite). |\n| `lowInventoryWarningThreshold` | `Int` | Limiar de \"estoque baixo\": o produto é considerado com estoque baixo quando a quantidade disponível fica igual ou menor que este valor. |\n| `productConfiguration.productId` | `ID` | Produto retornado. |\n| `productConfiguration.productVariantId` | `ID` | Variante retornada. |\n| `productConfiguration.productErpCode` | `String` | Código do produto no seu ERP, se cadastrado. |\n| `productConfiguration.variantErpCode` | `String` | Código da variante no seu ERP, se cadastrado. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **`null` não é erro.** Se o estoque nunca foi configurado para aquela combinação de produto e variante, a consulta retorna `null` em vez de um objeto com valores zerados. Trate isso como \"sem dado configurado\", não como estoque zero.\n- **`inventoryReserved` é somente leitura nesta operação.** O valor reflete pedidos em andamento e é recalculado automaticamente pela Unbox — não há argumento nesta query para alterá-lo.\n- **Disponibilidade real = `inventoryInStock - inventoryReserved`.** Combine com `canBackorder` na sua lógica de exibição: mesmo com disponibilidade zero ou negativa, a venda pode ainda ser permitida se `canBackorder` for `true`. Use `lowInventoryWarningThreshold` para sinalizar \"estoque baixo\" ao comprador antes de chegar a zero."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"be44f726-6c83-55f4-b62c-b525234a85e2"}],"id":"8b471933-d169-4fc8-afe4-090dee0d6127","_postman_id":"8b471933-d169-4fc8-afe4-090dee0d6127","description":""}],"id":"b2e23934-1587-4939-a4f2-590505212cd6","description":"Estoque
\nConsulta de saldo de estoque para uma configuração de produto (produto + variante) na sua loja. Cobre a operação simpleInventory.
\nTipos e enums compartilhados
\n\n\n\n| Tipo | \nCampos | \nDescrição | \n
\n\n\n\nProductConfigurationInput | \nproductId: ID!, productVariantId: ID! | \nIdentifica a combinação produto + variante para a qual você quer o saldo de estoque. | \n
\n\n
\n
Regras de negócio
\n\n- Escopo por loja via autenticação.
simpleInventory não recebe shopId como argumento — a loja é resolvida a partir do seu access_token. Basta autenticar-se corretamente. \nnull quando o estoque nunca foi inicializado. Se ninguém configurou o controle de estoque para aquela combinação de produto e variante, a consulta retorna null em vez de um objeto com valores zerados. Trate null como \"sem dado configurado\", não como estoque zero nem como erro.
\n","_postman_id":"b2e23934-1587-4939-a4f2-590505212cd6"},{"name":"Orders","item":[{"name":"Query","item":[{"name":"[Query] orders","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns orders data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"orders\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"orders returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.orders;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"ec1179dc-7317-544e-8988-192b450d9dc3","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Orders($filters: OrderFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: OrdersSortByField) {\n orders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n }\n nodes {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n shippingMethods\n }\n}","variables":"{\n \"filters\": {\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentStatus\": [\n \"completed\"\n ],\n \"paymentStatus\": [\n \"CREATED\"\n ],\n \"paymentLinkId\": \"https://exemplo.com\",\n \"searchField\": \"Example_String\",\n \"status\": [\n \"CANCELED\"\n ],\n \"shippingMethods\": [\n \"Example_String\"\n ],\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"source\": [\n \"STOREFRONT\"\n ],\n \"invoiceStatus\": [\n \"NOT_ISSUED\"\n ],\n \"sentToERP\": [\n \"SENT\"\n ]\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"orders
\nPropósito: Retorna uma lista paginada (Relay) dos pedidos da sua loja, com filtros por período, status, forma de pagamento, forma de entrega, canal de origem e mais.\nQuando usar: Para telas e rotinas de acompanhamento de pedidos — dashboards, sincronização periódica com seu ERP/OMS, ou qualquer cenário em que você precise varrer/filtrar vários pedidos. Para buscar um pedido específico já conhecido pelo referenceId, prefira orderByReferenceId (mais direto). É uma leitura pura, sem efeitos colaterais.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não existe (nem nunca existiu) um argumento de loja nesta operação.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nOrderFilterInput | \nNão | \nnull | \nFiltros da listagem. Omitido, retorna todos os pedidos da loja. Ver campos abaixo. | \n
\n\nafter | \nString | \nNão | \n— | \nCursor Relay: retorna apenas resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \n— | \nCursor Relay: retorna apenas resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n— | \nQuantidade máxima de resultados, avançando a partir de after (ou do início). | \n
\n\nlast | \nInt | \nNão | \n— | \nQuantidade máxima de resultados, retrocedendo a partir de before. | \n
\n\noffset | \nInt | \nNão | \n— | \nRetorna resultados a partir do N-ésimo item — alternativa a after baseada em posição numérica. | \n
\n\nsortOrder | \nSortOrder (asc/desc) | \nNão | \ndesc | \nDireção da ordenação. | \n
\n\nsortBy | \nOrdersSortByField | \nNão | \ncreatedAt | \nCampo de ordenação — ver valores abaixo. | \n
\n\n
\n
\n\n\n| Nome | \nTipo | \nDescrição | \n
\n\n\n\ncreatedAt | \nDateFilterInput ({ gte, lte }) | \nFiltra por período de criação. Ambos os campos são opcionais e combináveis — envie só um para um filtro \"a partir de\"/\"até\", ou os dois para um intervalo fechado. | \n
\n\nfulfillmentStatus | \n[OrderFulfillmentStatus] (new, processing, completed) | \nFiltra por status de atendimento/entrega. Lista com \"ou\": qualquer pedido cujo status esteja na lista é retornado. | \n
\n\npaymentStatus | \n[PaymentStatusEnum] | \nFiltra por status de pagamento. | \n
\n\npaymentLinkId | \nID | \nFiltra por pedidos originados de um link de pagamento específico (_id do link). | \n
\n\nsearchField | \nString | \nBusca textual: casa exatamente com o _id do pedido, ou por regex (case-insensitive) com referenceId, e-mail do comprador, CPF/CNPJ ou nome completo do comprador/destinatário e telefone. | \n
\n\nstatus | \n[OrderStatusEnum] | \nFiltra por status geral do pedido. | \n
\n\nshippingMethods | \n[String] | \nFiltra por nome do método de envio utilizado no pedido. | \n
\n\nfulfillmentTypes | \n[FulfillmentType] (SHIPPING, NONE) | \nFiltra por tipo de atendimento. | \n
\n\nsource | \n[OrderSourceEnum] | \nFiltra por canal de origem do pedido. | \n
\n\ninvoiceStatus | \n[OrderInvoiceStatus] | \nFiltra por status de emissão de nota fiscal. | \n
\n\nsentToERP | \n[OrderSentToErpEnum] (SENT, NOT_SENT) | \nFiltra por pedidos já enviados (ou não) ao ERP da loja. | \n
\n\n
\n
Todos os campos de filters são opcionais e combináveis entre si (aplicados com \"e\" — um pedido precisa satisfazer todos os filtros informados).
\n\n_id, createdAt (padrão), totalAmount, name (nome/razão social do destinatário), referenceId, shippingMethod.
\nRetorno
\nOrderConnection! — connection Relay (ver paginação no folder Orders). Cada node/edges[].node é um Order completo — mesmos campos documentados em \"Campos do objeto Order\" na visão geral do folder.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes | \n[Order] | \nAtalho com os pedidos da página atual, sem o wrapper de cursor. | \n
\n\nedges | \n[OrderEdge] | \nItens da página com cursor individual. | \n
\n\nedges[].cursor | \nString! | \nCursor daquele item — use em after/before de chamadas seguintes. | \n
\n\nedges[].node | \nOrder | \nO pedido. | \n
\n\npageInfo | \nPageInfo! | \nMetadados de paginação (hasNextPage, hasPreviousPage, startCursor, endCursor). | \n
\n\ntotalCount | \nInt! | \nTotal de pedidos que correspondem aos filtros, ignorando a paginação. | \n
\n\nshippingMethods | \n[String] | \nNão é a lista de métodos de envio da página atual. Ver Notas. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \nAuthorization ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nfirst e last enviados na mesma chamada, ou last e offset enviados na mesma chamada. | \nEnvie apenas uma combinação válida por vez — first/after para avançar, last/before para retroceder, ou offset no lugar de after. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo aqui. O conflito de paginação chega como um erro de validação com mensagem descritiva, sem extensions.code estável — identifique-o por errors[].message.
\n
\nNotas
\n\nshippingMethods ignora os filtros e a paginação da chamada. É a lista de todos os métodos de envio distintos já usados em pedidos da sua loja, sempre — não reflete filters nem qual página você está lendo. Não use este campo para \"quais métodos aparecem nesta página\"; ele serve para descobrir de antemão quais valores de shippingMethods existem para montar um filtro.searchField combina múltiplos critérios em um só campo. Não é possível restringir a busca a apenas um deles (ex.: só e-mail) — a mesma string é testada contra _id (exato), referenceId, e-mail, CPF/CNPJ e nome, todos por regex (exceto _id, que é correspondência exata).- Página padrão de 20 itens quando nem
first nem last são enviados (ver conflitos de paginação em Erros). \n- Filtros de lista (
[Enum]) funcionam como \"ou\": qualquer pedido cujo valor esteja entre os informados é retornado; filtros diferentes entre si se combinam com \"e\". \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"07d3186e-621c-4240-b866-993ba4905572","name":"200 - orders","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Orders($filters: OrderFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: OrdersSortByField) {\n orders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n }\n nodes {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n shippingMethods\n }\n}","variables":"{\n \"filters\": {\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentStatus\": [\n \"completed\"\n ],\n \"paymentStatus\": [\n \"CREATED\"\n ],\n \"paymentLinkId\": \"https://exemplo.com\",\n \"searchField\": \"Example_String\",\n \"status\": [\n \"CANCELED\"\n ],\n \"shippingMethods\": [\n \"Example_String\"\n ],\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"source\": [\n \"STOREFRONT\"\n ],\n \"invoiceStatus\": [\n \"NOT_ISSUED\"\n ],\n \"sentToERP\": [\n \"SENT\"\n ]\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## orders\n\n**Propósito:** Retorna uma lista paginada (Relay) dos pedidos da sua loja, com filtros por período, status, forma de pagamento, forma de entrega, canal de origem e mais.\n**Quando usar:** Para telas e rotinas de acompanhamento de pedidos — dashboards, sincronização periódica com seu ERP/OMS, ou qualquer cenário em que você precise varrer/filtrar vários pedidos. Para buscar um pedido específico já conhecido pelo `referenceId`, prefira `orderByReferenceId` (mais direto). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não existe (nem nunca existiu) um argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | ------------------------------------------------------------------------------------------------ |\n| `filters` | `OrderFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todos os pedidos da loja. Ver campos abaixo. |\n| `after` | `String` | Não | — | Cursor Relay: retorna apenas resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor Relay: retorna apenas resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados, avançando a partir de `after` (ou do início). |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados, retrocedendo a partir de `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item — alternativa a `after` baseada em posição numérica. |\n| `sortOrder` | `SortOrder` (`asc`/`desc`) | Não | `desc` | Direção da ordenação. |\n| `sortBy` | `OrdersSortByField` | Não | `createdAt` | Campo de ordenação — ver valores abaixo. |\n\n#### Campos de `filters` (`OrderFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt` | `DateFilterInput` (`{ gte, lte }`) | Filtra por período de criação. Ambos os campos são opcionais e combináveis — envie só um para um filtro \"a partir de\"/\"até\", ou os dois para um intervalo fechado. |\n| `fulfillmentStatus` | `[OrderFulfillmentStatus]` (`new`, `processing`, `completed`) | Filtra por status de atendimento/entrega. Lista com \"ou\": qualquer pedido cujo status esteja na lista é retornado. |\n| `paymentStatus` | `[PaymentStatusEnum]` | Filtra por status de pagamento. |\n| `paymentLinkId` | `ID` | Filtra por pedidos originados de um link de pagamento específico (`_id` do link). |\n| `searchField` | `String` | Busca textual: casa exatamente com o `_id` do pedido, ou por regex (case-insensitive) com `referenceId`, e-mail do comprador, CPF/CNPJ ou nome completo do comprador/destinatário e telefone. |\n| `status` | `[OrderStatusEnum]` | Filtra por status geral do pedido. |\n| `shippingMethods` | `[String]` | Filtra por nome do método de envio utilizado no pedido. |\n| `fulfillmentTypes` | `[FulfillmentType]` (`SHIPPING`, `NONE`) | Filtra por tipo de atendimento. |\n| `source` | `[OrderSourceEnum]` | Filtra por canal de origem do pedido. |\n| `invoiceStatus` | `[OrderInvoiceStatus]` | Filtra por status de emissão de nota fiscal. |\n| `sentToERP` | `[OrderSentToErpEnum]` (`SENT`, `NOT_SENT`) | Filtra por pedidos já enviados (ou não) ao ERP da loja. |\n\nTodos os campos de `filters` são opcionais e combináveis entre si (aplicados com \"e\" — um pedido precisa satisfazer todos os filtros informados).\n\n#### Valores de `sortBy` (`OrdersSortByField`)\n\n`_id`, `createdAt` (padrão), `totalAmount`, `name` (nome/razão social do destinatário), `referenceId`, `shippingMethod`.\n\n### Retorno\n\n`OrderConnection!` — connection Relay (ver paginação no folder Orders). Cada `node`/`edges[].node` é um `Order` completo — mesmos campos documentados em \"Campos do objeto `Order`\" na visão geral do folder.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | -------------------------------------------------------------------------------------- |\n| `nodes` | `[Order]` | Atalho com os pedidos da página atual, sem o wrapper de cursor. |\n| `edges` | `[OrderEdge]` | Itens da página com cursor individual. |\n| `edges[].cursor` | `String!` | Cursor daquele item — use em `after`/`before` de chamadas seguintes. |\n| `edges[].node` | `Order` | O pedido. |\n| `pageInfo` | `PageInfo!` | Metadados de paginação (`hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`). |\n| `totalCount` | `Int!` | Total de pedidos que correspondem aos filtros, ignorando a paginação. |\n| `shippingMethods` | `[String]` | **Não é a lista de métodos de envio da página atual.** Ver Notas. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | `first` e `last` enviados na mesma chamada, ou `last` e `offset` enviados na mesma chamada. | Envie apenas uma combinação válida por vez — `first`/`after` para avançar, `last`/`before` para retroceder, ou `offset` no lugar de `after`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. O conflito de paginação chega como um erro de validação com mensagem descritiva, sem `extensions.code` estável — identifique-o por `errors[].message`.\n\n### Notas\n\n- **`shippingMethods` ignora os filtros e a paginação da chamada.** É a lista de todos os métodos de envio distintos já usados em pedidos da sua loja, sempre — não reflete `filters` nem qual página você está lendo. Não use este campo para \"quais métodos aparecem nesta página\"; ele serve para descobrir de antemão quais valores de `shippingMethods` existem para montar um filtro.\n- **`searchField` combina múltiplos critérios em um só campo.** Não é possível restringir a busca a apenas um deles (ex.: só e-mail) — a mesma string é testada contra `_id` (exato), `referenceId`, e-mail, CPF/CNPJ e nome, todos por regex (exceto `_id`, que é correspondência exata).\n- **Página padrão de 20 itens** quando nem `first` nem `last` são enviados (ver conflitos de paginação em Erros).\n- **Filtros de lista (`[Enum]`) funcionam como \"ou\"**: qualquer pedido cujo valor esteja entre os informados é retornado; filtros diferentes entre si se combinam com \"e\"."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orders\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"cartId\": \"Example_ID\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayStatus\": \"Example_String\",\n \"email\": \"cliente@exemplo.com\",\n \"recurringOrderId\": \"Example_String\",\n \"recurringOrderCycleId\": \"Example_String\",\n \"generatedNewRecurringOrder\": true,\n \"recurringOrderFrequencyId\": \"Example_String\",\n \"referenceId\": \"Example_String\",\n \"source\": \"Example_String\",\n \"status\": \"CANCELED\",\n \"totalItemQuantity\": 10,\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"invoiceIssued\": true,\n \"sentToERP\": true,\n \"soldToCompany\": true,\n \"sentToLP\": true,\n \"dispatched\": true,\n \"delivered\": true,\n \"problemDelivering\": true,\n \"isBoletoPaid\": true,\n \"shippingLabelPending\": true,\n \"shippingLabelFailed\": true\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"025f008a-1223-40c4-94f1-ead3d7f15da0","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Orders($filters: OrderFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: OrdersSortByField) {\n orders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n }\n nodes {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n shippingMethods\n }\n}","variables":"{\n \"filters\": {\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentStatus\": [\n \"completed\"\n ],\n \"paymentStatus\": [\n \"CREATED\"\n ],\n \"paymentLinkId\": \"https://exemplo.com\",\n \"searchField\": \"Example_String\",\n \"status\": [\n \"CANCELED\"\n ],\n \"shippingMethods\": [\n \"Example_String\"\n ],\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"source\": [\n \"STOREFRONT\"\n ],\n \"invoiceStatus\": [\n \"NOT_ISSUED\"\n ],\n \"sentToERP\": [\n \"SENT\"\n ]\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## orders\n\n**Propósito:** Retorna uma lista paginada (Relay) dos pedidos da sua loja, com filtros por período, status, forma de pagamento, forma de entrega, canal de origem e mais.\n**Quando usar:** Para telas e rotinas de acompanhamento de pedidos — dashboards, sincronização periódica com seu ERP/OMS, ou qualquer cenário em que você precise varrer/filtrar vários pedidos. Para buscar um pedido específico já conhecido pelo `referenceId`, prefira `orderByReferenceId` (mais direto). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não existe (nem nunca existiu) um argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | ------------------------------------------------------------------------------------------------ |\n| `filters` | `OrderFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todos os pedidos da loja. Ver campos abaixo. |\n| `after` | `String` | Não | — | Cursor Relay: retorna apenas resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor Relay: retorna apenas resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados, avançando a partir de `after` (ou do início). |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados, retrocedendo a partir de `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item — alternativa a `after` baseada em posição numérica. |\n| `sortOrder` | `SortOrder` (`asc`/`desc`) | Não | `desc` | Direção da ordenação. |\n| `sortBy` | `OrdersSortByField` | Não | `createdAt` | Campo de ordenação — ver valores abaixo. |\n\n#### Campos de `filters` (`OrderFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt` | `DateFilterInput` (`{ gte, lte }`) | Filtra por período de criação. Ambos os campos são opcionais e combináveis — envie só um para um filtro \"a partir de\"/\"até\", ou os dois para um intervalo fechado. |\n| `fulfillmentStatus` | `[OrderFulfillmentStatus]` (`new`, `processing`, `completed`) | Filtra por status de atendimento/entrega. Lista com \"ou\": qualquer pedido cujo status esteja na lista é retornado. |\n| `paymentStatus` | `[PaymentStatusEnum]` | Filtra por status de pagamento. |\n| `paymentLinkId` | `ID` | Filtra por pedidos originados de um link de pagamento específico (`_id` do link). |\n| `searchField` | `String` | Busca textual: casa exatamente com o `_id` do pedido, ou por regex (case-insensitive) com `referenceId`, e-mail do comprador, CPF/CNPJ ou nome completo do comprador/destinatário e telefone. |\n| `status` | `[OrderStatusEnum]` | Filtra por status geral do pedido. |\n| `shippingMethods` | `[String]` | Filtra por nome do método de envio utilizado no pedido. |\n| `fulfillmentTypes` | `[FulfillmentType]` (`SHIPPING`, `NONE`) | Filtra por tipo de atendimento. |\n| `source` | `[OrderSourceEnum]` | Filtra por canal de origem do pedido. |\n| `invoiceStatus` | `[OrderInvoiceStatus]` | Filtra por status de emissão de nota fiscal. |\n| `sentToERP` | `[OrderSentToErpEnum]` (`SENT`, `NOT_SENT`) | Filtra por pedidos já enviados (ou não) ao ERP da loja. |\n\nTodos os campos de `filters` são opcionais e combináveis entre si (aplicados com \"e\" — um pedido precisa satisfazer todos os filtros informados).\n\n#### Valores de `sortBy` (`OrdersSortByField`)\n\n`_id`, `createdAt` (padrão), `totalAmount`, `name` (nome/razão social do destinatário), `referenceId`, `shippingMethod`.\n\n### Retorno\n\n`OrderConnection!` — connection Relay (ver paginação no folder Orders). Cada `node`/`edges[].node` é um `Order` completo — mesmos campos documentados em \"Campos do objeto `Order`\" na visão geral do folder.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | -------------------------------------------------------------------------------------- |\n| `nodes` | `[Order]` | Atalho com os pedidos da página atual, sem o wrapper de cursor. |\n| `edges` | `[OrderEdge]` | Itens da página com cursor individual. |\n| `edges[].cursor` | `String!` | Cursor daquele item — use em `after`/`before` de chamadas seguintes. |\n| `edges[].node` | `Order` | O pedido. |\n| `pageInfo` | `PageInfo!` | Metadados de paginação (`hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`). |\n| `totalCount` | `Int!` | Total de pedidos que correspondem aos filtros, ignorando a paginação. |\n| `shippingMethods` | `[String]` | **Não é a lista de métodos de envio da página atual.** Ver Notas. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | `first` e `last` enviados na mesma chamada, ou `last` e `offset` enviados na mesma chamada. | Envie apenas uma combinação válida por vez — `first`/`after` para avançar, `last`/`before` para retroceder, ou `offset` no lugar de `after`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. O conflito de paginação chega como um erro de validação com mensagem descritiva, sem `extensions.code` estável — identifique-o por `errors[].message`.\n\n### Notas\n\n- **`shippingMethods` ignora os filtros e a paginação da chamada.** É a lista de todos os métodos de envio distintos já usados em pedidos da sua loja, sempre — não reflete `filters` nem qual página você está lendo. Não use este campo para \"quais métodos aparecem nesta página\"; ele serve para descobrir de antemão quais valores de `shippingMethods` existem para montar um filtro.\n- **`searchField` combina múltiplos critérios em um só campo.** Não é possível restringir a busca a apenas um deles (ex.: só e-mail) — a mesma string é testada contra `_id` (exato), `referenceId`, e-mail, CPF/CNPJ e nome, todos por regex (exceto `_id`, que é correspondência exata).\n- **Página padrão de 20 itens** quando nem `first` nem `last` são enviados (ver conflitos de paginação em Erros).\n- **Filtros de lista (`[Enum]`) funcionam como \"ou\"**: qualquer pedido cujo valor esteja entre os informados é retornado; filtros diferentes entre si se combinam com \"e\"."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"115a4e82-b1aa-426a-9219-9d88509bf71b","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Orders($filters: OrderFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: OrdersSortByField) {\n orders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n }\n nodes {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n shippingMethods\n }\n}","variables":"{\n \"filters\": {\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n },\n \"fulfillmentStatus\": [\n \"completed\"\n ],\n \"paymentStatus\": [\n \"CREATED\"\n ],\n \"paymentLinkId\": \"https://exemplo.com\",\n \"searchField\": \"Example_String\",\n \"status\": [\n \"CANCELED\"\n ],\n \"shippingMethods\": [\n \"Example_String\"\n ],\n \"fulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"source\": [\n \"STOREFRONT\"\n ],\n \"invoiceStatus\": [\n \"NOT_ISSUED\"\n ],\n \"sentToERP\": [\n \"SENT\"\n ]\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## orders\n\n**Propósito:** Retorna uma lista paginada (Relay) dos pedidos da sua loja, com filtros por período, status, forma de pagamento, forma de entrega, canal de origem e mais.\n**Quando usar:** Para telas e rotinas de acompanhamento de pedidos — dashboards, sincronização periódica com seu ERP/OMS, ou qualquer cenário em que você precise varrer/filtrar vários pedidos. Para buscar um pedido específico já conhecido pelo `referenceId`, prefira `orderByReferenceId` (mais direto). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não existe (nem nunca existiu) um argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | -------------------------- | ----------- | ----------- | ------------------------------------------------------------------------------------------------ |\n| `filters` | `OrderFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todos os pedidos da loja. Ver campos abaixo. |\n| `after` | `String` | Não | — | Cursor Relay: retorna apenas resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor Relay: retorna apenas resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados, avançando a partir de `after` (ou do início). |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados, retrocedendo a partir de `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item — alternativa a `after` baseada em posição numérica. |\n| `sortOrder` | `SortOrder` (`asc`/`desc`) | Não | `desc` | Direção da ordenação. |\n| `sortBy` | `OrdersSortByField` | Não | `createdAt` | Campo de ordenação — ver valores abaixo. |\n\n#### Campos de `filters` (`OrderFilterInput`)\n\n| Nome | Tipo | Descrição |\n| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `createdAt` | `DateFilterInput` (`{ gte, lte }`) | Filtra por período de criação. Ambos os campos são opcionais e combináveis — envie só um para um filtro \"a partir de\"/\"até\", ou os dois para um intervalo fechado. |\n| `fulfillmentStatus` | `[OrderFulfillmentStatus]` (`new`, `processing`, `completed`) | Filtra por status de atendimento/entrega. Lista com \"ou\": qualquer pedido cujo status esteja na lista é retornado. |\n| `paymentStatus` | `[PaymentStatusEnum]` | Filtra por status de pagamento. |\n| `paymentLinkId` | `ID` | Filtra por pedidos originados de um link de pagamento específico (`_id` do link). |\n| `searchField` | `String` | Busca textual: casa exatamente com o `_id` do pedido, ou por regex (case-insensitive) com `referenceId`, e-mail do comprador, CPF/CNPJ ou nome completo do comprador/destinatário e telefone. |\n| `status` | `[OrderStatusEnum]` | Filtra por status geral do pedido. |\n| `shippingMethods` | `[String]` | Filtra por nome do método de envio utilizado no pedido. |\n| `fulfillmentTypes` | `[FulfillmentType]` (`SHIPPING`, `NONE`) | Filtra por tipo de atendimento. |\n| `source` | `[OrderSourceEnum]` | Filtra por canal de origem do pedido. |\n| `invoiceStatus` | `[OrderInvoiceStatus]` | Filtra por status de emissão de nota fiscal. |\n| `sentToERP` | `[OrderSentToErpEnum]` (`SENT`, `NOT_SENT`) | Filtra por pedidos já enviados (ou não) ao ERP da loja. |\n\nTodos os campos de `filters` são opcionais e combináveis entre si (aplicados com \"e\" — um pedido precisa satisfazer todos os filtros informados).\n\n#### Valores de `sortBy` (`OrdersSortByField`)\n\n`_id`, `createdAt` (padrão), `totalAmount`, `name` (nome/razão social do destinatário), `referenceId`, `shippingMethod`.\n\n### Retorno\n\n`OrderConnection!` — connection Relay (ver paginação no folder Orders). Cada `node`/`edges[].node` é um `Order` completo — mesmos campos documentados em \"Campos do objeto `Order`\" na visão geral do folder.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | -------------------------------------------------------------------------------------- |\n| `nodes` | `[Order]` | Atalho com os pedidos da página atual, sem o wrapper de cursor. |\n| `edges` | `[OrderEdge]` | Itens da página com cursor individual. |\n| `edges[].cursor` | `String!` | Cursor daquele item — use em `after`/`before` de chamadas seguintes. |\n| `edges[].node` | `Order` | O pedido. |\n| `pageInfo` | `PageInfo!` | Metadados de paginação (`hasNextPage`, `hasPreviousPage`, `startCursor`, `endCursor`). |\n| `totalCount` | `Int!` | Total de pedidos que correspondem aos filtros, ignorando a paginação. |\n| `shippingMethods` | `[String]` | **Não é a lista de métodos de envio da página atual.** Ver Notas. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | `first` e `last` enviados na mesma chamada, ou `last` e `offset` enviados na mesma chamada. | Envie apenas uma combinação válida por vez — `first`/`after` para avançar, `last`/`before` para retroceder, ou `offset` no lugar de `after`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. O conflito de paginação chega como um erro de validação com mensagem descritiva, sem `extensions.code` estável — identifique-o por `errors[].message`.\n\n### Notas\n\n- **`shippingMethods` ignora os filtros e a paginação da chamada.** É a lista de todos os métodos de envio distintos já usados em pedidos da sua loja, sempre — não reflete `filters` nem qual página você está lendo. Não use este campo para \"quais métodos aparecem nesta página\"; ele serve para descobrir de antemão quais valores de `shippingMethods` existem para montar um filtro.\n- **`searchField` combina múltiplos critérios em um só campo.** Não é possível restringir a busca a apenas um deles (ex.: só e-mail) — a mesma string é testada contra `_id` (exato), `referenceId`, e-mail, CPF/CNPJ e nome, todos por regex (exceto `_id`, que é correspondência exata).\n- **Página padrão de 20 itens** quando nem `first` nem `last` são enviados (ver conflitos de paginação em Erros).\n- **Filtros de lista (`[Enum]`) funcionam como \"ou\"**: qualquer pedido cujo valor esteja entre os informados é retornado; filtros diferentes entre si se combinam com \"e\"."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"ec1179dc-7317-544e-8988-192b450d9dc3"},{"name":"[Query] orderByReferenceId","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns orderByReferenceId data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"orderByReferenceId\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"orderByReferenceId returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.orderByReferenceId;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.account !== undefined && data.account !== null) {"," pm.expect(data.account).to.be.an(\"object\");"," }"," if (data.cartId !== undefined && data.cartId !== null) {"," pm.expect(typeof data.cartId).to.equal(\"string\");"," }"," if (data.paymentLink !== undefined && data.paymentLink !== null) {"," pm.expect(data.paymentLink).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.discounts !== undefined && data.discounts !== null) {"," pm.expect(data.discounts).to.be.an(\"array\");"," }"," pm.expect(data).to.have.property(\"displayStatus\");"," if (data.displayStatus !== undefined && data.displayStatus !== null) {"," pm.expect(typeof data.displayStatus).to.equal(\"string\");"," }"," if (data.email !== undefined && data.email !== null) {"," pm.expect(typeof data.email).to.equal(\"string\");"," }"," if (data.fulfillmentGroups !== undefined && data.fulfillmentGroups !== null) {"," pm.expect(data.fulfillmentGroups).to.be.an(\"array\");"," }"," if (data.notes !== undefined && data.notes !== null) {"," pm.expect(data.notes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"d21a29af-cd9d-5113-8f89-92fe5e8f1a2e","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query OrderByReferenceId($id: ID!) {\n orderByReferenceId(id: $id) {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n}","variables":"{\n \"id\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"orderByReferenceId
\nPropósito: Retorna um único pedido pelo seu referenceId — o identificador público exibido ao comprador (recibo, e-mail de confirmação, etc.), e não o _id interno do pedido.\nQuando usar: Fluxo pós-compra — consulte esta operação para acompanhar a situação de um pedido específico depois que um checkout foi concluído (por exemplo, a partir do referenceId retornado ao final de um link de pagamento, ou de um orderId/referenceId que você já armazenou do seu lado). É uma leitura pura, sem efeitos colaterais.\nAutenticação: x-api-key + Authorization. O shopId é injetado a partir do seu token — não envie esse argumento (ele nem existe no schema desta operação).
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nid | \nID! | \nSim | \n— | \nO referenceId do pedido — o identificador público mostrado ao comprador, não o _id interno. | \n
\n\n
\n
Retorno
\nUm objeto Order — ver \"Campos do objeto Order\" na visão geral do folder Orders para a lista completa de propriedades (status, itens/entrega, financeiro, pagamentos, notas, etc.).
\nAtenção: diferente de outras consultas por identificador desta API, esta operação não retorna null quando não há um pedido correspondente — ela responde com um erro (ver Erros abaixo). Trate a ausência do pedido como uma falha esperada, não como um resultado vazio.
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \nAuthorization ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nNenhum pedido com esse id (referenceId) existe para a loja associada ao seu token — inclui o caso de o pedido pertencer a outra loja. | \nConfirme o referenceId enviado. A busca é sempre restrita à loja do seu token; não é possível consultar pedidos de outra loja mesmo conhecendo o referenceId. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha. O erro de \"pedido não encontrado\" não carrega extensions.code estável — identifique-o pelo texto de message.
\n
\nNotas
\n\n- Sem resultado é erro, não
null. Ao contrário de operações semelhantes desta API (ex.: consultas de estoque ou de grupo de produtos), um referenceId inexistente ou de outra loja faz a chamada falhar em vez de devolver um objeto vazio. \nreferenceId, não _id. Use sempre o identificador público mostrado ao comprador — o _id interno do pedido não é aceito por este argumento.displayStatus(language: String!) exige o idioma como argumento (ex.: displayStatus(language: \"pt-BR\")) e devolve o valor bruto de status quando a loja não tiver rótulos customizados configurados para aquele idioma.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"51f04be6-7af8-4810-8d7d-52e9e71ae6f4","name":"200 - orderByReferenceId","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query OrderByReferenceId($id: ID!) {\n orderByReferenceId(id: $id) {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n}","variables":"{\n \"id\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## orderByReferenceId\n\n**Propósito:** Retorna um único pedido pelo seu `referenceId` — o identificador público exibido ao comprador (recibo, e-mail de confirmação, etc.), e não o `_id` interno do pedido.\n**Quando usar:** Fluxo pós-compra — consulte esta operação para acompanhar a situação de um pedido específico depois que um checkout foi concluído (por exemplo, a partir do `referenceId` retornado ao final de um link de pagamento, ou de um `orderId`/`referenceId` que você já armazenou do seu lado). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento (ele nem existe no schema desta operação).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---- | ----- | ----------- | ------- | ----------------------------------------------------------------------------------------------- |\n| `id` | `ID!` | Sim | — | O `referenceId` do pedido — o identificador público mostrado ao comprador, não o `_id` interno. |\n\n### Retorno\n\nUm objeto `Order` — ver \"Campos do objeto `Order`\" na visão geral do folder Orders para a lista completa de propriedades (status, itens/entrega, financeiro, pagamentos, notas, etc.).\n\n**Atenção:** diferente de outras consultas por identificador desta API, esta operação **não** retorna `null` quando não há um pedido correspondente — ela responde com um erro (ver Erros abaixo). Trate a ausência do pedido como uma falha esperada, não como um resultado vazio.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Nenhum pedido com esse `id` (`referenceId`) existe para a loja associada ao seu token — inclui o caso de o pedido pertencer a outra loja. | Confirme o `referenceId` enviado. A busca é sempre restrita à loja do seu token; não é possível consultar pedidos de outra loja mesmo conhecendo o `referenceId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. O erro de \"pedido não encontrado\" não carrega `extensions.code` estável — identifique-o pelo texto de `message`.\n\n### Notas\n\n- **Sem resultado é erro, não `null`.** Ao contrário de operações semelhantes desta API (ex.: consultas de estoque ou de grupo de produtos), um `referenceId` inexistente ou de outra loja faz a chamada falhar em vez de devolver um objeto vazio.\n- **`referenceId`, não `_id`.** Use sempre o identificador público mostrado ao comprador — o `_id` interno do pedido não é aceito por este argumento.\n- **`displayStatus(language: String!)`** exige o idioma como argumento (ex.: `displayStatus(language: \"pt-BR\")`) e devolve o valor bruto de `status` quando a loja não tiver rótulos customizados configurados para aquele idioma."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"orderByReferenceId\": {\n \"_id\": \"Example_ID\",\n \"account\": {\n \"_id\": \"Example_ID\",\n \"bio\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"firstName\": \"Example_String\",\n \"language\": \"Example_String\",\n \"lastName\": \"Example_String\",\n \"name\": \"Example_String\",\n \"note\": \"Example_String\",\n \"picture\": \"Example_String\",\n \"preferences\": {},\n \"primaryEmailAddress\": \"cliente@exemplo.com\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"userId\": \"Example_String\",\n \"username\": \"Example_String\",\n \"externalAccountId\": \"Example_String\",\n \"isFirstAccess\": true\n },\n \"cartId\": \"Example_ID\",\n \"paymentLink\": {\n \"_id\": \"Example_ID\",\n \"referenceId\": \"Example_String\",\n \"type\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"externalId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"title\": \"Example_String\",\n \"createdBy\": \"Example_String\",\n \"updatedBy\": \"Example_String\",\n \"status\": \"ACTIVE\",\n \"isSoldOut\": true,\n \"isExpired\": true,\n \"description\": \"Example_String\",\n \"ordersCount\": 10,\n \"blockPaymentMethodChange\": true,\n \"blockApplyDiscountCode\": true,\n \"blockApplyShopSale\": true\n },\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"discounts\": [\n {\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discount\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\"\n }\n ],\n \"displayStatus\": \"Example_String\",\n \"email\": \"cliente@exemplo.com\",\n \"fulfillmentGroups\": [\n {\n \"_id\": \"Example_ID\",\n \"displayStatus\": \"Example_String\",\n \"status\": \"Example_String\",\n \"totalItemQuantity\": 10,\n \"trackingCode\": \"Example_String\",\n \"type\": \"SHIPPING\"\n }\n ],\n \"notes\": [\n {\n \"content\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"payments\": [\n {\n \"_id\": \"Example_ID\",\n \"captureErrorCode\": \"Example_String\",\n \"captureErrorMessage\": \"Example_String\",\n \"cardBrand\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayName\": \"Example_String\",\n \"isAuthorizationCanceled\": true,\n \"isCaptured\": true,\n \"mode\": \"Example_String\",\n \"processor\": \"Example_String\",\n \"riskLevel\": \"elevated\",\n \"tookLossOnSale\": true,\n \"transactionId\": \"Example_String\",\n \"threeDSChallengeRequested\": true,\n \"threeDSChallengePayload\": {}\n }\n ],\n \"shipping\": [\n {}\n ],\n \"shopSales\": [\n {\n \"_id\": \"Example_ID\",\n \"amount\": 99.99,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"currencyCode\": \"BRL\",\n \"data\": {},\n \"displayName\": \"Example_String\",\n \"method\": \"Example_String\",\n \"mode\": \"Example_String\",\n \"name\": \"Example_String\",\n \"paymentPluginName\": \"Example_String\",\n \"processor\": \"Example_String\",\n \"status\": \"Example_String\",\n \"transactionId\": \"Example_String\"\n }\n ],\n \"recurringOrderId\": \"Example_String\",\n \"recurringOrderCycleId\": \"Example_String\",\n \"generatedNewRecurringOrder\": true,\n \"recurringOrderFrequencyId\": \"Example_String\",\n \"referenceId\": \"Example_String\",\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"source\": \"Example_String\",\n \"status\": \"CANCELED\",\n \"summary\": {},\n \"totalItemQuantity\": 10,\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"invoiceIssued\": true,\n \"sentToERP\": true,\n \"soldToCompany\": true,\n \"sentToLP\": true,\n \"dispatched\": true,\n \"delivered\": true,\n \"problemDelivering\": true,\n \"isBoletoPaid\": true,\n \"shippingLabelPending\": true,\n \"shippingLabelFailed\": true,\n \"surcharges\": [\n {\n \"_id\": \"Example_ID\",\n \"fulfillmentGroupId\": \"Example_ID\",\n \"message\": \"Example_String\",\n \"surchargeDefinitionId\": \"Example_ID\"\n }\n ]\n }\n }\n}"},{"id":"262bbd5b-0319-4089-b1d0-ae56c4bd4869","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query OrderByReferenceId($id: ID!) {\n orderByReferenceId(id: $id) {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n}","variables":"{\n \"id\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## orderByReferenceId\n\n**Propósito:** Retorna um único pedido pelo seu `referenceId` — o identificador público exibido ao comprador (recibo, e-mail de confirmação, etc.), e não o `_id` interno do pedido.\n**Quando usar:** Fluxo pós-compra — consulte esta operação para acompanhar a situação de um pedido específico depois que um checkout foi concluído (por exemplo, a partir do `referenceId` retornado ao final de um link de pagamento, ou de um `orderId`/`referenceId` que você já armazenou do seu lado). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento (ele nem existe no schema desta operação).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---- | ----- | ----------- | ------- | ----------------------------------------------------------------------------------------------- |\n| `id` | `ID!` | Sim | — | O `referenceId` do pedido — o identificador público mostrado ao comprador, não o `_id` interno. |\n\n### Retorno\n\nUm objeto `Order` — ver \"Campos do objeto `Order`\" na visão geral do folder Orders para a lista completa de propriedades (status, itens/entrega, financeiro, pagamentos, notas, etc.).\n\n**Atenção:** diferente de outras consultas por identificador desta API, esta operação **não** retorna `null` quando não há um pedido correspondente — ela responde com um erro (ver Erros abaixo). Trate a ausência do pedido como uma falha esperada, não como um resultado vazio.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Nenhum pedido com esse `id` (`referenceId`) existe para a loja associada ao seu token — inclui o caso de o pedido pertencer a outra loja. | Confirme o `referenceId` enviado. A busca é sempre restrita à loja do seu token; não é possível consultar pedidos de outra loja mesmo conhecendo o `referenceId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. O erro de \"pedido não encontrado\" não carrega `extensions.code` estável — identifique-o pelo texto de `message`.\n\n### Notas\n\n- **Sem resultado é erro, não `null`.** Ao contrário de operações semelhantes desta API (ex.: consultas de estoque ou de grupo de produtos), um `referenceId` inexistente ou de outra loja faz a chamada falhar em vez de devolver um objeto vazio.\n- **`referenceId`, não `_id`.** Use sempre o identificador público mostrado ao comprador — o `_id` interno do pedido não é aceito por este argumento.\n- **`displayStatus(language: String!)`** exige o idioma como argumento (ex.: `displayStatus(language: \"pt-BR\")`) e devolve o valor bruto de `status` quando a loja não tiver rótulos customizados configurados para aquele idioma."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"7a99ba9c-8a73-4b01-a840-d2a56e443264","name":"Erro - REFERENCE_ID_AND_SHOP_ID_ARE_REQUIRED_ERROR","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query OrderByReferenceId($id: ID!) {\n orderByReferenceId(id: $id) {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderSummary {\n type\n description\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n successCallbackURL\n customerData {\n firstName {\n value\n editable\n }\n lastName {\n value\n editable\n }\n address1 {\n value\n editable\n }\n address2 {\n value\n editable\n }\n number {\n value\n editable\n }\n neighborhood {\n value\n editable\n }\n city {\n value\n editable\n }\n region {\n value\n editable\n }\n postal {\n value\n editable\n }\n phone {\n value\n editable\n }\n taxPayerId {\n value\n editable\n }\n email {\n value\n editable\n }\n }\n discount {\n discountId\n code\n method\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n totalDiscount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n attributes {\n label\n value\n }\n cancelReason\n createdAt\n imageURLs {\n large\n medium\n original\n small\n thumbnail\n }\n isRecurring\n isDiscountedBonusItem\n discountedBonusItemSource {\n discountMethod\n discountCalculationMethod\n }\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n pricingPolicy {\n type\n value\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n optionTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n kitItemConfigurations {\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n productType\n productVendor\n quantity\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n subtotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxCode\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n displayAmount\n }\n }\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n availability {\n days\n startHour\n endHour\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n description\n label\n }\n handlingPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n discountPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n history {\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n value {\n status\n description\n origin\n destination\n createdAt\n }\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n tax {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxName\n taxRate {\n amount\n displayPercent\n percent\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n updatedAt\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n}","variables":"{\n \"id\": \"Example_ID\"\n}"}},"url":"{{base_url}}","description":"## orderByReferenceId\n\n**Propósito:** Retorna um único pedido pelo seu `referenceId` — o identificador público exibido ao comprador (recibo, e-mail de confirmação, etc.), e não o `_id` interno do pedido.\n**Quando usar:** Fluxo pós-compra — consulte esta operação para acompanhar a situação de um pedido específico depois que um checkout foi concluído (por exemplo, a partir do `referenceId` retornado ao final de um link de pagamento, ou de um `orderId`/`referenceId` que você já armazenou do seu lado). É uma leitura pura, sem efeitos colaterais.\n**Autenticação:** `x-api-key` + `Authorization`. O `shopId` é injetado a partir do seu token — não envie esse argumento (ele nem existe no schema desta operação).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---- | ----- | ----------- | ------- | ----------------------------------------------------------------------------------------------- |\n| `id` | `ID!` | Sim | — | O `referenceId` do pedido — o identificador público mostrado ao comprador, não o `_id` interno. |\n\n### Retorno\n\nUm objeto `Order` — ver \"Campos do objeto `Order`\" na visão geral do folder Orders para a lista completa de propriedades (status, itens/entrega, financeiro, pagamentos, notas, etc.).\n\n**Atenção:** diferente de outras consultas por identificador desta API, esta operação **não** retorna `null` quando não há um pedido correspondente — ela responde com um erro (ver Erros abaixo). Trate a ausência do pedido como uma falha esperada, não como um resultado vazio.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `Authorization` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Nenhum pedido com esse `id` (`referenceId`) existe para a loja associada ao seu token — inclui o caso de o pedido pertencer a outra loja. | Confirme o `referenceId` enviado. A busca é sempre restrita à loja do seu token; não é possível consultar pedidos de outra loja mesmo conhecendo o `referenceId`. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha. O erro de \"pedido não encontrado\" não carrega `extensions.code` estável — identifique-o pelo texto de `message`.\n\n### Notas\n\n- **Sem resultado é erro, não `null`.** Ao contrário de operações semelhantes desta API (ex.: consultas de estoque ou de grupo de produtos), um `referenceId` inexistente ou de outra loja faz a chamada falhar em vez de devolver um objeto vazio.\n- **`referenceId`, não `_id`.** Use sempre o identificador público mostrado ao comprador — o `_id` interno do pedido não é aceito por este argumento.\n- **`displayStatus(language: String!)`** exige o idioma como argumento (ex.: `displayStatus(language: \"pt-BR\")`) e devolve o valor bruto de `status` quando a loja não tiver rótulos customizados configurados para aquele idioma."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": null,\n \"errors\": [\n {\n \"message\": \"Reference id and shop id are required error\",\n \"extensions\": {\n \"code\": \"REFERENCE_ID_AND_SHOP_ID_ARE_REQUIRED_ERROR\"\n }\n }\n ]\n}"}],"_postman_id":"d21a29af-cd9d-5113-8f89-92fe5e8f1a2e"}],"id":"d5d9df18-13cc-444b-af08-24abb2d5a2d1","_postman_id":"d5d9df18-13cc-444b-af08-24abb2d5a2d1","description":""}],"id":"cc319dfc-8c10-4074-acc4-808a5c025830","description":"Orders
\nConsulta de pedidos feitos na sua loja — por referenceId público (orderByReferenceId) ou em uma lista paginada e filtrável (orders). É o principal ponto de acompanhamento pós-compra da API: use estas operações depois que um checkout foi concluído (por exemplo, após createExternalCheckout ou o pagamento de um link) para saber o que aconteceu com o pedido gerado.
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores | \nDescrição | \n
\n\n\n\nOrderStatusEnum | \nCANCELED, COMPLETED, FAILED, PENDING, PROCESSING, REFUNDED | \nStatus geral do pedido. | \n
\n\nOrderFulfillmentStatus | \nnew, processing, completed | \nStatus do processo de entrega/atendimento do pedido, usado no filtro de orders. | \n
\n\nPaymentStatusEnum | \nCREATED, AUTHORIZED, CAPTURED, CANCELED, REFUNDED, PAID, PENDING, EXPIRED, CHARGED_BACK, FAILED | \nStatus de um pagamento individual vinculado ao pedido. | \n
\n\nOrderSourceEnum | \nSTOREFRONT, CART_TEMPLATE, PAYMENT_LINK | \nCanal de origem do pedido: loja online, template de carrinho ou link de pagamento (ex.: gerado por createExternalCheckout). | \n
\n\nOrderInvoiceStatus | \nNOT_ISSUED, PENDING, FAILED, ISSUED | \nStatus de emissão de nota fiscal de um grupo de entrega do pedido. | \n
\n\nOrderSentToErpEnum | \nSENT, NOT_SENT | \nUsado apenas como valor de filtro em orders — indica se o pedido já foi enviado para o ERP da loja. | \n
\n\nFulfillmentType | \nSHIPPING, NONE | \nTipo de atendimento de um grupo de entrega do pedido. | \n
\n\n
\n
Campos do objeto Order
\nTanto orderByReferenceId quanto cada item retornado por orders (nodes[]/edges[].node) têm exatamente este formato.
\nIdentificação e status
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nIdentificador interno do pedido. | \n
\n\nreferenceId | \nString! | \nIdentificador público do pedido, mostrado ao comprador (é o valor usado em orderByReferenceId). | \n
\n\nstatus | \nOrderStatusEnum! | \nStatus geral do pedido. | \n
\n\ndisplayStatus(language: String!) | \nString! | \nRótulo do status legível para humanos, traduzido para o idioma informado (ex.: \"pt-BR\") se a loja tiver rótulos customizados configurados; caso contrário, retorna o valor bruto de status. | \n
\n\nsource | \nString! | \nCanal de origem do pedido — ver OrderSourceEnum. | \n
\n\ncreatedAt / updatedAt | \nAWSDateTime! | \nDatas de criação e última atualização do pedido. | \n
\n\n
\n
Cliente e loja
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\naccount | \nAccount | \nConta do comprador dona do pedido. null quando o pedido não está vinculado a uma conta. | \n
\n\nemail | \nString | \nE-mail do comprador informado no pedido. | \n
\n\nshop | \nShop! | \nLoja dona do pedido (sempre a loja associada à sua conta autenticada). | \n
\n\ncartId | \nID | \nIdentificador do carrinho de origem, quando aplicável. | \n
\n\n
\n
Itens e entrega
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ntotalItemQuantity | \nInt! | \nSoma das quantidades de todos os itens do pedido. | \n
\n\nfulfillmentGroups | \n[OrderFulfillmentGroup]! | \nItens agrupados por forma de atendimento. Cada grupo traz type (SHIPPING/NONE), status, address, trackingCode (código de rastreio simples, texto), tracking (objeto com code, url e event, quando disponível), selectedFulfillmentOption (método de envio escolhido) e items (lista paginada de OrderItem, com price, quantity, attributes, etc.). | \n
\n\nshipping | \n[OrderShipping] | \nNotas fiscais associadas ao pedido — cada item traz invoice.url e invoice.status (OrderInvoiceStatus). | \n
\n\n
\n
Financeiro
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nsummary | \nOrderSummary! | \nTotais do pedido: summary.total (total cobrado), summary.itemTotal, summary.taxTotal/summary.taxableAmount, summary.discountTotal/summary.totalSavings, summary.fulfillmentTotal (frete), summary.installmentAmount/summary.interest/summary.totalBeforeInterest (preenchidos quando o pedido foi parcelado), summary.totalWithoutDiscounts/summary.totalWithoutAnySavings. Todo valor monetário é um Money (amount, currency, displayAmount já formatado). | \n
\n\ndiscounts | \n[OrderDiscount]! | \nDescontos aplicados ao pedido — code, discountMethod, discountedAmount. | \n
\n\npayments | \n[Payment] | \nPagamentos vinculados ao pedido (pode haver mais de um). Cada um traz method, amount, transactionId, cardBrand, isCaptured e status. status é um objeto (fluxo do pagamento), não o enum diretamente — o valor atual está em status.status (PaymentStatusEnum), e status.history[] traz o histórico de mudanças. Consulte payments { status { status } }, não payments { status }. | \n
\n\npaymentLink | \nPaymentLink | \nLink de pagamento que originou o pedido, quando source indicar que ele veio de um link. null para pedidos de outras origens. | \n
\n\nshopSales | \n[CartBilling] | \nDetalhamento de cobrança do pedido para a loja, quando aplicável. | \n
\n\ninvoiceIssued / sentToERP / sentToLP | \nBoolean! | \nSinalizadores de faturamento e integração — nota fiscal emitida, enviado ao ERP da loja, enviado à plataforma logística. | \n
\n\nsoldToCompany / isBoletoPaid | \nBoolean | \nSe vendido para pessoa jurídica, e (para pagamento via boleto) se já foi pago. null quando não aplicável/ainda não determinado. | \n
\n\n
\n
Entrega física
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ndispatched / delivered / problemDelivering | \nBoolean | \nSinalizadores do ciclo de despacho e entrega física. null quando não aplicável ao tipo de atendimento do pedido. | \n
\n\nshippingLabelPending / shippingLabelFailed | \nBoolean | \nIndicam se a etiqueta de envio ainda está sendo gerada ou se a geração falhou. | \n
\n\n
\n
Recorrência e notas
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nrecurringOrderId / recurringOrderCycleId / recurringOrderFrequencyId | \nString | \nPreenchidos apenas quando o pedido teve origem em uma assinatura recorrente; null caso contrário. | \n
\n\ngeneratedNewRecurringOrder | \nBoolean | \nIndica se este pedido gerou um novo ciclo de recorrência. | \n
\n\nnotes | \n[OrderNote]! | \nNotas registradas no pedido — content, account (quem registrou), createdAt. | \n
\n\n
\n
Paginação Relay (orders)
\norders retorna uma connection Relay com edges ({ cursor, node }), nodes (atalho sem o wrapper de cursor), pageInfo (hasNextPage, hasPreviousPage, startCursor, endCursor) e totalCount. Para avançar página, envie first + after: <pageInfo.endCursor>; para retroceder, last + before: <pageInfo.startCursor>. Alternativamente, offset pagina por deslocamento numérico. sortOrder (asc/desc, padrão desc) e sortBy controlam a ordenação — padrão createdAt.
\nRegras de negócio
\n\n- Só
orderByReferenceId tem o shopId injetado a partir do seu token. orders nunca teve (nem tem) um argumento de loja no schema — ela já é implicitamente restrita à loja da sua conta autenticada, do mesmo jeito que qualquer outra query autenticada desta API. \n- Pedido não encontrado é um erro, não um retorno vazio. Diferente de outras consultas por identificador desta API (que retornam
null quando não há resultado), orderByReferenceId responde com um erro quando o id informado não corresponde a nenhum pedido da sua loja — ver Erros na página da operação. \ndisplayStatus exige o argumento language em ambas as operações. Sem rótulos customizados configurados na loja, ele simplesmente devolve o valor bruto de status.
\n","_postman_id":"cc319dfc-8c10-4074-acc4-808a5c025830"},{"name":"Products","item":[{"name":"Query","item":[{"name":"[Query] product","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns product data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"product\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"product returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.product;"," "," if (data !== null) {"," if (data.price !== undefined && data.price !== null) {"," pm.expect(data.price).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"pricing\");"," if (data.pricing !== undefined && data.pricing !== null) {"," pm.expect(data.pricing).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.currentProductHash !== undefined && data.currentProductHash !== null) {"," pm.expect(typeof data.currentProductHash).to.equal(\"string\");"," }"," if (data.description !== undefined && data.description !== null) {"," pm.expect(typeof data.description).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"isDeleted\");"," if (data.isDeleted !== undefined && data.isDeleted !== null) {"," pm.expect(typeof data.isDeleted).to.equal(\"boolean\");"," }"," if (data.isProductPublishable !== undefined && data.isProductPublishable !== null) {"," pm.expect(data.isProductPublishable).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"isVisible\");"," if (data.isVisible !== undefined && data.isVisible !== null) {"," pm.expect(typeof data.isVisible).to.equal(\"boolean\");"," }"," }","});"]}}],"id":"fae4ad96-8525-579c-a9b7-3efe71db1fd7","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Product($productId: ID!) {\n product(productId: $productId) {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"product
\nPropósito: Retorna os dados administrativos completos de um único produto (tipo SIMPLE, VARIANT ou OPTION) a partir do seu ID — identificação, mídia, estado de publicação, variantes, SEO, tags e preço.\nQuando usar: Para consultar ou sincronizar um item específico do catálogo (por exemplo, montar/atualizar uma ficha de produto no seu canal, checar se está publicado/visível, ou revalidar preço antes de um checkout). Para a visão de vitrine já publicada (com URL publicada e descrições de card), prefira catalogItemProductBySlug; se o item for um kit, use productKit.\nAutenticação: x-api-key + Authorization. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nproductId | \nID! | \nSim | \n— | \nID do produto a consultar. | \n
\n\n
\n
Retorno
\nProduct — os dados administrativos do produto. Principais grupos de campos:
\n\n\n\n| Grupo | \nCampos | \nDescrição | \n
\n\n\n\n| Identificação | \n_id, title, slug, erpCode, vendor, type, description | \nIdentificação e classificação do produto. | \n
\n\n| Mídia | \nmedia, imageUrls, videoUrls | \nImagens e vídeos do produto. | \n
\n\n| Publicação | \nisVisible, isDeleted, publishedAt, isProductPublishable, currentProductHash, publishedProductHash, shouldAppearInSitemap | \nEstado de publicação/visibilidade e hashes de versão. | \n
\n\n| Variantes | \nvariants | \nVariantes/opções do produto (com o próprio pricing por variante). | \n
\n\n| SEO | \npageTitle, metaDescription, socialMetadata | \nMetadados de SEO e compartilhamento. | \n
\n\n| Tags/organização | \ntagIds, tags, metafields, sortIndex | \nTags, metafields e ordenação. | \n
\n\n| Outros | \noriginCountry, supportedFulfillmentTypes, createdAt, updatedAt | \nPaís de origem, tipos de fulfillment suportados e timestamps. | \n
\n\n
\n
Preço (price/pricing) detalhado:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nprice | \nProductPriceRange | \nFaixa de preço do produto (relevante quando o item tem variantes com preços diferentes). | \n
\n\nprice.min / price.max | \nFloat | \nMenor/maior preço entre as combinações possíveis do produto. | \n
\n\nprice.range | \nString | \nTexto pronto para exibição da faixa de preço. | \n
\n\npricing | \nVariantPricingInfo! | \nInformações de preço para exibição direta. | \n
\n\npricing.price | \nFloat | \nPreço do item quando ele já é uma unidade vendável (sem variantes/opções pendentes de seleção). É null quando o produto ainda depende de escolher uma variante/opção. | \n
\n\npricing.minPrice / pricing.maxPrice | \nFloat! | \nMenor/maior preço possível considerando as combinações de variante/opção. | \n
\n\npricing.compareAtPrice | \nMoney | \nPreço \"de/por\" (ex.: preço riscado). É null quando pricing.price também é null. | \n
\n\npricing.displayPrice | \nString! | \nTexto pronto para exibição, já incluindo o símbolo da moeda (ex.: \"R$ 149,90\" ou uma faixa como \"R$ 3,95 - R$ 6,99\"). | \n
\n\npricing.currency | \nCurrency! | \nMoeda em que os valores acima estão expressos (code, symbol, format, etc.). | \n
\n\npricing.currencyExchangePricing(currencyCode) | \nCurrencyExchangeProductPricingInfo | \nMesmas informações de preço convertidas para outra moeda (currencyCode no padrão ISO, ex.: \"USD\"). | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.
\n
\nNotas
\n\nproductId inexistente (ou de outra loja/tipo) não gera erro. A resposta é product: null. Isso inclui passar o ID de um produto do tipo KIT — use productKit para esses.- Este é o mesmo comportamento de tipo/filtro documentado no folder: apenas produtos SIMPLE, VARIANT e OPTION são retornados por esta operação.
\n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a521c8a5-262b-4889-9497-d3648bba62f1","name":"200 - product","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Product($productId: ID!) {\n product(productId: $productId) {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## product\n\n**Propósito:** Retorna os dados administrativos completos de um único produto (tipo SIMPLE, VARIANT ou OPTION) a partir do seu ID — identificação, mídia, estado de publicação, variantes, SEO, tags e preço.\n**Quando usar:** Para consultar ou sincronizar um item específico do catálogo (por exemplo, montar/atualizar uma ficha de produto no seu canal, checar se está publicado/visível, ou revalidar preço antes de um checkout). Para a visão de vitrine já publicada (com URL publicada e descrições de card), prefira `catalogItemProductBySlug`; se o item for um kit, use `productKit`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto a consultar. |\n\n### Retorno\n\n`Product` — os dados administrativos do produto. Principais grupos de campos:\n\n| Grupo | Campos | Descrição |\n| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| Identificação | `_id`, `title`, `slug`, `erpCode`, `vendor`, `type`, `description` | Identificação e classificação do produto. |\n| Mídia | `media`, `imageUrls`, `videoUrls` | Imagens e vídeos do produto. |\n| Publicação | `isVisible`, `isDeleted`, `publishedAt`, `isProductPublishable`, `currentProductHash`, `publishedProductHash`, `shouldAppearInSitemap` | Estado de publicação/visibilidade e hashes de versão. |\n| Variantes | `variants` | Variantes/opções do produto (com o próprio `pricing` por variante). |\n| SEO | `pageTitle`, `metaDescription`, `socialMetadata` | Metadados de SEO e compartilhamento. |\n| Tags/organização | `tagIds`, `tags`, `metafields`, `sortIndex` | Tags, metafields e ordenação. |\n| Outros | `originCountry`, `supportedFulfillmentTypes`, `createdAt`, `updatedAt` | País de origem, tipos de fulfillment suportados e timestamps. |\n\nPreço (`price`/`pricing`) detalhado:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `price` | `ProductPriceRange` | Faixa de preço do produto (relevante quando o item tem variantes com preços diferentes). |\n| `price.min` / `price.max` | `Float` | Menor/maior preço entre as combinações possíveis do produto. |\n| `price.range` | `String` | Texto pronto para exibição da faixa de preço. |\n| `pricing` | `VariantPricingInfo!` | Informações de preço para exibição direta. |\n| `pricing.price` | `Float` | Preço do item quando ele já é uma unidade vendável (sem variantes/opções pendentes de seleção). É `null` quando o produto ainda depende de escolher uma variante/opção. |\n| `pricing.minPrice` / `pricing.maxPrice` | `Float!` | Menor/maior preço possível considerando as combinações de variante/opção. |\n| `pricing.compareAtPrice` | `Money` | Preço \"de/por\" (ex.: preço riscado). É `null` quando `pricing.price` também é `null`. |\n| `pricing.displayPrice` | `String!` | Texto pronto para exibição, já incluindo o símbolo da moeda (ex.: `\"R$ 149,90\"` ou uma faixa como `\"R$ 3,95 - R$ 6,99\"`). |\n| `pricing.currency` | `Currency!` | Moeda em que os valores acima estão expressos (`code`, `symbol`, `format`, etc.). |\n| `pricing.currencyExchangePricing(currencyCode)` | `CurrencyExchangeProductPricingInfo` | Mesmas informações de preço convertidas para outra moeda (`currencyCode` no padrão ISO, ex.: `\"USD\"`). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `product: null`. Isso inclui passar o ID de um produto do tipo KIT — use `productKit` para esses.\n- Este é o mesmo comportamento de tipo/filtro documentado no folder: apenas produtos SIMPLE, VARIANT e OPTION são retornados por esta operação."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"product\": {\n \"price\": {\n \"max\": 99.99,\n \"min\": 99.99,\n \"range\": \"Example_String\"\n },\n \"pricing\": {\n \"displayPrice\": 99.99,\n \"maxPrice\": 99.99,\n \"minPrice\": 99.99,\n \"price\": 99.99\n },\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"currentProductHash\": \"Example_String\",\n \"description\": \"Example_String\",\n \"isDeleted\": true,\n \"isProductPublishable\": {\n \"isProductPublishable\": true\n },\n \"isVisible\": true,\n \"imageUrls\": [\n \"https://exemplo.com\"\n ],\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"media\": [\n {\n \"_id\": \"Example_ID\",\n \"priority\": 10,\n \"productId\": \"Example_ID\",\n \"variantId\": \"Example_ID\"\n }\n ],\n \"metaDescription\": \"Example_String\",\n \"metafields\": [\n {\n \"description\": \"Example_String\",\n \"key\": \"Example_String\",\n \"namespace\": \"Example_String\",\n \"scope\": \"Example_String\",\n \"value\": 99.99,\n \"valueType\": \"Example_String\"\n }\n ],\n \"originCountry\": \"Example_String\",\n \"pageTitle\": \"Example_String\",\n \"type\": \"SIMPLE\",\n \"publishedAt\": \"2025-01-15T10:00:00Z\",\n \"publishedProductHash\": \"Example_String\",\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"shouldAppearInSitemap\": true,\n \"slug\": \"Example_String\",\n \"socialMetadata\": [\n {\n \"message\": \"Example_String\",\n \"service\": \"facebook\"\n }\n ],\n \"supportedFulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"tags\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n },\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"variants\": [\n {\n \"compareAtPrice\": 99.99,\n \"price\": 99.99,\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"attributeLabel\": \"Example_String\",\n \"barcode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"height\": 99.99,\n \"index\": 10,\n \"isDeleted\": true,\n \"isVisible\": true,\n \"imageUrls\": [\n \"https://exemplo.com\"\n ],\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"length\": 99.99,\n \"minOrderQuantity\": 10,\n \"maxOrderQuantity\": 10,\n \"optionTitle\": \"Example_String\",\n \"originCountry\": \"Example_String\",\n \"sku\": \"Example_String\",\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"weight\": 99.99,\n \"width\": 99.99,\n \"isTaxable\": true,\n \"taxCode\": \"Example_String\",\n \"taxDescription\": \"Example_String\"\n }\n ],\n \"vendor\": \"Example_String\",\n \"sortIndex\": 10\n }\n }\n}"},{"id":"7ed78af0-37f3-4a6e-af1d-3393a7482dcc","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Product($productId: ID!) {\n product(productId: $productId) {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## product\n\n**Propósito:** Retorna os dados administrativos completos de um único produto (tipo SIMPLE, VARIANT ou OPTION) a partir do seu ID — identificação, mídia, estado de publicação, variantes, SEO, tags e preço.\n**Quando usar:** Para consultar ou sincronizar um item específico do catálogo (por exemplo, montar/atualizar uma ficha de produto no seu canal, checar se está publicado/visível, ou revalidar preço antes de um checkout). Para a visão de vitrine já publicada (com URL publicada e descrições de card), prefira `catalogItemProductBySlug`; se o item for um kit, use `productKit`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto a consultar. |\n\n### Retorno\n\n`Product` — os dados administrativos do produto. Principais grupos de campos:\n\n| Grupo | Campos | Descrição |\n| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| Identificação | `_id`, `title`, `slug`, `erpCode`, `vendor`, `type`, `description` | Identificação e classificação do produto. |\n| Mídia | `media`, `imageUrls`, `videoUrls` | Imagens e vídeos do produto. |\n| Publicação | `isVisible`, `isDeleted`, `publishedAt`, `isProductPublishable`, `currentProductHash`, `publishedProductHash`, `shouldAppearInSitemap` | Estado de publicação/visibilidade e hashes de versão. |\n| Variantes | `variants` | Variantes/opções do produto (com o próprio `pricing` por variante). |\n| SEO | `pageTitle`, `metaDescription`, `socialMetadata` | Metadados de SEO e compartilhamento. |\n| Tags/organização | `tagIds`, `tags`, `metafields`, `sortIndex` | Tags, metafields e ordenação. |\n| Outros | `originCountry`, `supportedFulfillmentTypes`, `createdAt`, `updatedAt` | País de origem, tipos de fulfillment suportados e timestamps. |\n\nPreço (`price`/`pricing`) detalhado:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `price` | `ProductPriceRange` | Faixa de preço do produto (relevante quando o item tem variantes com preços diferentes). |\n| `price.min` / `price.max` | `Float` | Menor/maior preço entre as combinações possíveis do produto. |\n| `price.range` | `String` | Texto pronto para exibição da faixa de preço. |\n| `pricing` | `VariantPricingInfo!` | Informações de preço para exibição direta. |\n| `pricing.price` | `Float` | Preço do item quando ele já é uma unidade vendável (sem variantes/opções pendentes de seleção). É `null` quando o produto ainda depende de escolher uma variante/opção. |\n| `pricing.minPrice` / `pricing.maxPrice` | `Float!` | Menor/maior preço possível considerando as combinações de variante/opção. |\n| `pricing.compareAtPrice` | `Money` | Preço \"de/por\" (ex.: preço riscado). É `null` quando `pricing.price` também é `null`. |\n| `pricing.displayPrice` | `String!` | Texto pronto para exibição, já incluindo o símbolo da moeda (ex.: `\"R$ 149,90\"` ou uma faixa como `\"R$ 3,95 - R$ 6,99\"`). |\n| `pricing.currency` | `Currency!` | Moeda em que os valores acima estão expressos (`code`, `symbol`, `format`, etc.). |\n| `pricing.currencyExchangePricing(currencyCode)` | `CurrencyExchangeProductPricingInfo` | Mesmas informações de preço convertidas para outra moeda (`currencyCode` no padrão ISO, ex.: `\"USD\"`). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `product: null`. Isso inclui passar o ID de um produto do tipo KIT — use `productKit` para esses.\n- Este é o mesmo comportamento de tipo/filtro documentado no folder: apenas produtos SIMPLE, VARIANT e OPTION são retornados por esta operação."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"cce9983f-8aa0-4321-83cb-0dd03c33631e","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Product($productId: ID!) {\n product(productId: $productId) {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## product\n\n**Propósito:** Retorna os dados administrativos completos de um único produto (tipo SIMPLE, VARIANT ou OPTION) a partir do seu ID — identificação, mídia, estado de publicação, variantes, SEO, tags e preço.\n**Quando usar:** Para consultar ou sincronizar um item específico do catálogo (por exemplo, montar/atualizar uma ficha de produto no seu canal, checar se está publicado/visível, ou revalidar preço antes de um checkout). Para a visão de vitrine já publicada (com URL publicada e descrições de card), prefira `catalogItemProductBySlug`; se o item for um kit, use `productKit`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto a consultar. |\n\n### Retorno\n\n`Product` — os dados administrativos do produto. Principais grupos de campos:\n\n| Grupo | Campos | Descrição |\n| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| Identificação | `_id`, `title`, `slug`, `erpCode`, `vendor`, `type`, `description` | Identificação e classificação do produto. |\n| Mídia | `media`, `imageUrls`, `videoUrls` | Imagens e vídeos do produto. |\n| Publicação | `isVisible`, `isDeleted`, `publishedAt`, `isProductPublishable`, `currentProductHash`, `publishedProductHash`, `shouldAppearInSitemap` | Estado de publicação/visibilidade e hashes de versão. |\n| Variantes | `variants` | Variantes/opções do produto (com o próprio `pricing` por variante). |\n| SEO | `pageTitle`, `metaDescription`, `socialMetadata` | Metadados de SEO e compartilhamento. |\n| Tags/organização | `tagIds`, `tags`, `metafields`, `sortIndex` | Tags, metafields e ordenação. |\n| Outros | `originCountry`, `supportedFulfillmentTypes`, `createdAt`, `updatedAt` | País de origem, tipos de fulfillment suportados e timestamps. |\n\nPreço (`price`/`pricing`) detalhado:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `price` | `ProductPriceRange` | Faixa de preço do produto (relevante quando o item tem variantes com preços diferentes). |\n| `price.min` / `price.max` | `Float` | Menor/maior preço entre as combinações possíveis do produto. |\n| `price.range` | `String` | Texto pronto para exibição da faixa de preço. |\n| `pricing` | `VariantPricingInfo!` | Informações de preço para exibição direta. |\n| `pricing.price` | `Float` | Preço do item quando ele já é uma unidade vendável (sem variantes/opções pendentes de seleção). É `null` quando o produto ainda depende de escolher uma variante/opção. |\n| `pricing.minPrice` / `pricing.maxPrice` | `Float!` | Menor/maior preço possível considerando as combinações de variante/opção. |\n| `pricing.compareAtPrice` | `Money` | Preço \"de/por\" (ex.: preço riscado). É `null` quando `pricing.price` também é `null`. |\n| `pricing.displayPrice` | `String!` | Texto pronto para exibição, já incluindo o símbolo da moeda (ex.: `\"R$ 149,90\"` ou uma faixa como `\"R$ 3,95 - R$ 6,99\"`). |\n| `pricing.currency` | `Currency!` | Moeda em que os valores acima estão expressos (`code`, `symbol`, `format`, etc.). |\n| `pricing.currencyExchangePricing(currencyCode)` | `CurrencyExchangeProductPricingInfo` | Mesmas informações de preço convertidas para outra moeda (`currencyCode` no padrão ISO, ex.: `\"USD\"`). |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `product: null`. Isso inclui passar o ID de um produto do tipo KIT — use `productKit` para esses.\n- Este é o mesmo comportamento de tipo/filtro documentado no folder: apenas produtos SIMPLE, VARIANT e OPTION são retornados por esta operação."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"fae4ad96-8525-579c-a9b7-3efe71db1fd7"},{"name":"[Query] products","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns products data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"products\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"products returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.products;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"34c4f5d2-ab37-57fb-99a0-3b90ef747433","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Products($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n products(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n }\n nodes {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"products
\nPropósito: Lista, com paginação, os produtos do tipo SIMPLE, VARIANT e OPTION da sua loja, com filtros por arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual.\nQuando usar: Para montar ou sincronizar um catálogo no seu canal, aplicar filtros de exibição (ex.: apenas produtos visíveis e não arquivados) ou buscar produtos por texto/tag/metafield antes de decidir quais exibir. Para um único item já conhecido, prefira product, que evita o overhead de paginação.\nAutenticação: x-api-key + Authorization. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.
\nArgumentos
\nTodos os argumentos são opcionais e combináveis. Ver a seção Paginação Relay no folder deste domínio para os argumentos de paginação.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nisArchived | \nBoolean | \nNão | \nnull (sem filtro) | \nFiltra por produtos arquivados (true) ou não arquivados (false). | \n
\n\nisVisible | \nBoolean | \nNão | \nnull (sem filtro) | \nFiltra por produtos visíveis (true) ou ocultos (false) na loja. | \n
\n\nmetafieldKey | \nString | \nNão | \nnull | \nFiltra por produtos que tenham um metafield com esta chave. Combine com metafieldValue. | \n
\n\nmetafieldValue | \nString | \nNão | \nnull | \nFiltra por produtos que tenham um metafield com este valor. Combine com metafieldKey. | \n
\n\npriceMin | \nFloat | \nNão | \nnull | \nPreço mínimo do produto. | \n
\n\npriceMax | \nFloat | \nNão | \nnull | \nPreço máximo do produto. | \n
\n\nproductIds | \n[ID] | \nNão | \nnull | \nLista de IDs de produto para restringir o resultado a esse conjunto específico. | \n
\n\nquery | \nString | \nNão | \nnull | \nBusca textual (regex) livre sobre o produto. | \n
\n\ntagIds | \n[ID] | \nNão | \nnull | \nLista de IDs de tag para filtrar produtos associados a qualquer uma delas. | \n
\n\nafter | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar. Use com after ou offset. | \n
\n\nlast | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar, a partir do fim. Use com before (não combine com offset). | \n
\n\noffset | \nInt | \nNão | \nnull | \nPula os N primeiros resultados. Use com first (não combine com last). | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nDireção da ordenação (asc/desc). | \n
\n\nsortBy | \nProductSortByField | \nNão | \ncreatedAt | \nCampo de ordenação (_id, createdAt, title, updatedAt). | \n
\n\n
\n
Retorno
\nProductConnection — uma connection Relay (ver Paginação Relay no folder deste domínio). Cada nó é um Product completo (identificação, mídia, estado de publicação, variantes, SEO, tags e preço) — ver a operação product para o detalhamento dos grupos de campos e de price/pricing.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nedges[].cursor | \nString! | \nCursor do item, usado com after/before para paginar. | \n
\n\nedges[].node | \nProduct | \nO produto em si (mesma forma retornada por product). | \n
\n\nnodes | \n[Product] | \nAtalho com os produtos diretamente, sem o wrapper de cursor de edges. | \n
\n\npageInfo.hasNextPage | \nBoolean! | \nSe há mais resultados após a página atual. | \n
\n\npageInfo.hasPreviousPage | \nBoolean! | \nSe há resultados antes da página atual. | \n
\n\npageInfo.startCursor | \nString | \nCursor do primeiro item da página atual. | \n
\n\npageInfo.endCursor | \nString | \nCursor do último item da página atual. | \n
\n\ntotalCount | \nInt! | \nTotal de produtos que atendem aos filtros, independente da paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nArgumentos last e offset enviados juntos. | \nErro de validação com mensagem descritiva, sem extensions.code estável. Envie apenas um dos dois esquemas de paginação por chamada. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio.
\n
\nNotas
\n\n- Sem filtros, esta operação retorna todo o catálogo elegível (SIMPLE/VARIANT/OPTION) da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de
totalCount sozinho para decidir o volume de chamadas. \nquery faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1834d6b7-dbd9-4a0d-afe7-f51691d0ac1b","name":"200 - products","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Products($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n products(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n }\n nodes {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## products\n\n**Propósito:** Lista, com paginação, os produtos do tipo SIMPLE, VARIANT e OPTION da sua loja, com filtros por arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual.\n**Quando usar:** Para montar ou sincronizar um catálogo no seu canal, aplicar filtros de exibição (ex.: apenas produtos visíveis e não arquivados) ou buscar produtos por texto/tag/metafield antes de decidir quais exibir. Para um único item já conhecido, prefira `product`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do produto. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do produto. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de produto para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o produto. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar produtos associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `Product` completo (identificação, mídia, estado de publicação, variantes, SEO, tags e preço) — ver a operação `product` para o detalhamento dos grupos de campos e de `price`/`pricing`.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------- | ----------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `Product` | O produto em si (mesma forma retornada por `product`). |\n| `nodes` | `[Product]` | Atalho com os produtos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de produtos que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todo o catálogo elegível (SIMPLE/VARIANT/OPTION) da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"products\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"currentProductHash\": \"Example_String\",\n \"description\": \"Example_String\",\n \"isDeleted\": true,\n \"isVisible\": true,\n \"imageUrls\": [\n \"https://exemplo.com\"\n ],\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"metaDescription\": \"Example_String\",\n \"originCountry\": \"Example_String\",\n \"pageTitle\": \"Example_String\",\n \"type\": \"SIMPLE\",\n \"publishedAt\": \"2025-01-15T10:00:00Z\",\n \"publishedProductHash\": \"Example_String\",\n \"shouldAppearInSitemap\": true,\n \"slug\": \"Example_String\",\n \"supportedFulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"vendor\": \"Example_String\",\n \"sortIndex\": 10\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"efd22d55-ad22-4904-b667-8bfcfb20537e","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Products($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n products(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n }\n nodes {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## products\n\n**Propósito:** Lista, com paginação, os produtos do tipo SIMPLE, VARIANT e OPTION da sua loja, com filtros por arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual.\n**Quando usar:** Para montar ou sincronizar um catálogo no seu canal, aplicar filtros de exibição (ex.: apenas produtos visíveis e não arquivados) ou buscar produtos por texto/tag/metafield antes de decidir quais exibir. Para um único item já conhecido, prefira `product`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do produto. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do produto. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de produto para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o produto. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar produtos associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `Product` completo (identificação, mídia, estado de publicação, variantes, SEO, tags e preço) — ver a operação `product` para o detalhamento dos grupos de campos e de `price`/`pricing`.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------- | ----------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `Product` | O produto em si (mesma forma retornada por `product`). |\n| `nodes` | `[Product]` | Atalho com os produtos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de produtos que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todo o catálogo elegível (SIMPLE/VARIANT/OPTION) da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"8839459d-4cc4-4b2d-b7ca-ac305beb9a8d","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Products($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n products(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n }\n nodes {\n price {\n max\n min\n range\n }\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n variants {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n vendor\n sortIndex\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## products\n\n**Propósito:** Lista, com paginação, os produtos do tipo SIMPLE, VARIANT e OPTION da sua loja, com filtros por arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual.\n**Quando usar:** Para montar ou sincronizar um catálogo no seu canal, aplicar filtros de exibição (ex.: apenas produtos visíveis e não arquivados) ou buscar produtos por texto/tag/metafield antes de decidir quais exibir. Para um único item já conhecido, prefira `product`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por produtos visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por produtos que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do produto. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do produto. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de produto para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o produto. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar produtos associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `Product` completo (identificação, mídia, estado de publicação, variantes, SEO, tags e preço) — ver a operação `product` para o detalhamento dos grupos de campos e de `price`/`pricing`.\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------- | ----------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `Product` | O produto em si (mesma forma retornada por `product`). |\n| `nodes` | `[Product]` | Atalho com os produtos diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de produtos que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todo o catálogo elegível (SIMPLE/VARIANT/OPTION) da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"34c4f5d2-ab37-57fb-99a0-3b90ef747433"},{"name":"[Query] productKit","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns productKit data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"productKit\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"productKit returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.productKit;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"requiredPicksPerGroup\");"," if (data.requiredPicksPerGroup !== undefined && data.requiredPicksPerGroup !== null) {"," pm.expect(typeof data.requiredPicksPerGroup).to.equal(\"number\");"," }"," if (data.titleLabel !== undefined && data.titleLabel !== null) {"," pm.expect(typeof data.titleLabel).to.equal(\"string\");"," }"," if (data.highlightLabel !== undefined && data.highlightLabel !== null) {"," pm.expect(typeof data.highlightLabel).to.equal(\"string\");"," }"," if (data.unitPriceLabel !== undefined && data.unitPriceLabel !== null) {"," pm.expect(typeof data.unitPriceLabel).to.equal(\"string\");"," }"," if (data.kitGroupDescription !== undefined && data.kitGroupDescription !== null) {"," pm.expect(typeof data.kitGroupDescription).to.equal(\"string\");"," }"," if (data.price !== undefined && data.price !== null) {"," pm.expect(typeof data.price).to.equal(\"number\");"," }"," if (data.compareAtPrice !== undefined && data.compareAtPrice !== null) {"," pm.expect(typeof data.compareAtPrice).to.equal(\"number\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," }","});"]}}],"id":"21b74673-fdcb-57de-9b4f-89108a952adb","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKit($productId: ID!) {\n productKit(productId: $productId) {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"productKit
\nPropósito: Retorna um único produto do tipo KIT (combo com componentes obrigatórios) a partir do seu ID, com título, preço, mídia, tags e a lista de componentes.\nQuando usar: Para exibir a página de um kit específico ou consultar seus componentes antes de montar um carrinho. Para um item que não é kit, use product.\nAutenticação: x-api-key + Authorization. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nproductId | \nID! | \nSim | \n— | \nID do produto (kit) a consultar. | \n
\n\n
\n
Retorno
\nProductKit.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nID! | \nID do kit. | \n
\n\ntitle | \nString | \nTítulo do kit. | \n
\n\ntitleLabel | \nString | \nTexto customizado de um rótulo exibido junto ao título. | \n
\n\ndescription | \nString | \nDescrição completa do kit (pode conter quebras de linha). | \n
\n\nslug | \nString | \nIdentificador legível e único para URL. | \n
\n\ntype | \nProductTypesEnum | \nSempre KIT para esta operação. | \n
\n\nprice | \nMoney | \nPreço do kit. | \n
\n\ncompareAtPrice | \nMoney | \nPreço \"de\" (comparação), quando aplicável. | \n
\n\nerpCode | \nString | \nCódigo do kit no ERP, se houver. | \n
\n\nrequiredPicksPerGroup | \nInt! | \nQuantidade de escolhas obrigatórias por grupo de componentes para o kit poder ser adicionado a um carrinho. | \n
\n\nkitComponents | \n[ProductKitComponent]! | \nComponentes (produto + variante) que formam o kit. Ver tabela abaixo. Pode conter menos itens que a configuração original (ver Notas). | \n
\n\nkitGroupDescription | \nString | \nTexto descritivo da seção de componentes do kit. | \n
\n\nhighlightLabel | \nString | \nRótulo de destaque do kit em relação a outros. | \n
\n\nunitPriceLabel | \nString | \nRótulo do que representa a unidade do kit (ex.: caixa, sabor, lata). | \n
\n\nunitPriceFactor | \nInt | \nFator de divisão para calcular o preço por unidade do kit. | \n
\n\nrelatedInfo | \nProductKitRelatedInfo | \nInformações resumidas do kit (title, highlightLabel, showUnitPrice) usadas quando o kit é referenciado em outro contexto. | \n
\n\nisVisible | \nBoolean! | \nSe o kit deve ser exibido para compradores. | \n
\n\nisDeleted | \nBoolean! | \nSe o kit foi excluído (kits excluídos normalmente não são retornados pelas queries). | \n
\n\nisProductPublishable | \nIsProductPublishable | \nisProductPublishable (Boolean) + errorsList ([{ message, path }]) detalhando o que falta para o kit poder ser publicado. | \n
\n\nimageUrls / videoUrls | \n[String] | \nURLs de imagens/vídeos do kit. | \n
\n\nmedia(shouldIncludeVariantMedia) | \n[ImageInfo] | \nMídia completa do kit (URLs.large/medium/original/small/thumbnail, priority). Por padrão (shouldIncludeVariantMedia: true) inclui também mídia das variantes componentes. | \n
\n\nmetafields | \n[Metafield]! | \nAtributos customizados (key, value, namespace, scope, valueType, description). | \n
\n\nsocialMetadata | \n[SocialMetadata] | \nTexto de compartilhamento sugerido por rede social (message, service). | \n
\n\ntagIds / tags | \n[ID] / TagConnection | \nIDs de tags associadas e a connection paginada correspondente. | \n
\n\nvendor | \nString | \nFabricante/fornecedor do kit, para exibição. | \n
\n\nminOrderQuantity / maxOrderQuantity | \nInt | \nQuantidade mínima/máxima do kit permitida por pedido. | \n
\n\nsupportedFulfillmentTypes | \n[FulfillmentType]! | \nTipos de atendimento suportados (SHIPPING, NONE). | \n
\n\nshouldAppearInSitemap | \nBoolean | \nSe o kit deve aparecer no sitemap gerado. | \n
\n\nshop | \nShop! | \nReferência à loja à qual o kit pertence. | \n
\n\nsortIndex | \nInt | \nÍndice de ordenação manual do kit em listagens. | \n
\n\ncurrentProductHash / publishedProductHash | \nString | \nHashes para comparar se o kit mudou desde a última publicação. | \n
\n\npublishedAt | \nAWSDateTime | \nData/hora da última publicação. null se nunca publicado. | \n
\n\ncreatedAt / updatedAt | \nAWSDateTime! / AWSDateTime | \nDatas de criação/atualização do kit. | \n
\n\nmeasurementsInformation | \nString | \nInformações de medidas (ex.: roupas, móveis). | \n
\n\noriginCountry | \nString | \nPaís de origem do kit. | \n
\n\npageTitle | \nString | \nSubtítulo do kit. | \n
\n\nmetaDescription | \nString | \nDescrição usada na meta tag description da página do kit. | \n
\n\n
\n
Campos de kitComponents[] (ProductKitComponent)
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nproductTitle | \nString | \nTítulo do produto original que originou o componente. | \n
\n\nvariantTitle | \nString | \nTítulo da variante que compõe o kit. | \n
\n\nprice | \nMoney | \nPreço da variante componente. | \n
\n\nlabel | \nString | \nRótulo que pode sobrescrever o título da variante na listagem do kit. | \n
\n\nkitLabelImage | \nString | \nURL de imagem usada como rótulo visual do componente. | \n
\n\nproductId | \nID | \nID do produto original do componente. | \n
\n\nproductVariantId | \nID | \nID da variante do componente. | \n
\n\nproductErpCode / variantErpCode | \nString | \nCódigos ERP do produto/variante do componente, quando existirem. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.
\n
\nNotas
\n\nproductId inexistente (ou de outra loja/tipo) não gera erro. A resposta é productKit: null. Isso inclui passar o ID de um produto que não seja do tipo KIT — use product para esses.kitComponents pode vir incompleto silenciosamente. Se um produto ou variante que compõe o kit foi excluído (ou não é mais encontrado por outro motivo), aquele componente simplesmente não aparece no array — a operação não lança erro nesse caso. Não assuma que o tamanho de kitComponents reflete exatamente a configuração original do kit; se precisar detectar essa divergência, compare com requiredPicksPerGroup e a quantidade de componentes esperada pelo seu catálogo interno.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2149723a-51ce-4f9d-abf5-929b9f89c4ee","name":"200 - productKit","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKit($productId: ID!) {\n productKit(productId: $productId) {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## productKit\n\n**Propósito:** Retorna um único produto do tipo KIT (combo com componentes obrigatórios) a partir do seu ID, com título, preço, mídia, tags e a lista de componentes.\n**Quando usar:** Para exibir a página de um kit específico ou consultar seus componentes antes de montar um carrinho. Para um item que não é kit, use `product`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto (kit) a consultar. |\n\n### Retorno\n\n`ProductKit`.\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do kit. |\n| `title` | `String` | Título do kit. |\n| `titleLabel` | `String` | Texto customizado de um rótulo exibido junto ao título. |\n| `description` | `String` | Descrição completa do kit (pode conter quebras de linha). |\n| `slug` | `String` | Identificador legível e único para URL. |\n| `type` | `ProductTypesEnum` | Sempre `KIT` para esta operação. |\n| `price` | `Money` | Preço do kit. |\n| `compareAtPrice` | `Money` | Preço \"de\" (comparação), quando aplicável. |\n| `erpCode` | `String` | Código do kit no ERP, se houver. |\n| `requiredPicksPerGroup` | `Int!` | Quantidade de escolhas obrigatórias por grupo de componentes para o kit poder ser adicionado a um carrinho. |\n| `kitComponents` | `[ProductKitComponent]!` | Componentes (produto + variante) que formam o kit. Ver tabela abaixo. Pode conter menos itens que a configuração original (ver Notas). |\n| `kitGroupDescription` | `String` | Texto descritivo da seção de componentes do kit. |\n| `highlightLabel` | `String` | Rótulo de destaque do kit em relação a outros. |\n| `unitPriceLabel` | `String` | Rótulo do que representa a unidade do kit (ex.: caixa, sabor, lata). |\n| `unitPriceFactor` | `Int` | Fator de divisão para calcular o preço por unidade do kit. |\n| `relatedInfo` | `ProductKitRelatedInfo` | Informações resumidas do kit (`title`, `highlightLabel`, `showUnitPrice`) usadas quando o kit é referenciado em outro contexto. |\n| `isVisible` | `Boolean!` | Se o kit deve ser exibido para compradores. |\n| `isDeleted` | `Boolean!` | Se o kit foi excluído (kits excluídos normalmente não são retornados pelas queries). |\n| `isProductPublishable` | `IsProductPublishable` | `isProductPublishable` (Boolean) + `errorsList` (`[{ message, path }]`) detalhando o que falta para o kit poder ser publicado. |\n| `imageUrls` / `videoUrls` | `[String]` | URLs de imagens/vídeos do kit. |\n| `media(shouldIncludeVariantMedia)` | `[ImageInfo]` | Mídia completa do kit (`URLs.large/medium/original/small/thumbnail`, `priority`). Por padrão (`shouldIncludeVariantMedia: true`) inclui também mídia das variantes componentes. |\n| `metafields` | `[Metafield]!` | Atributos customizados (`key`, `value`, `namespace`, `scope`, `valueType`, `description`). |\n| `socialMetadata` | `[SocialMetadata]` | Texto de compartilhamento sugerido por rede social (`message`, `service`). |\n| `tagIds` / `tags` | `[ID]` / `TagConnection` | IDs de tags associadas e a connection paginada correspondente. |\n| `vendor` | `String` | Fabricante/fornecedor do kit, para exibição. |\n| `minOrderQuantity` / `maxOrderQuantity` | `Int` | Quantidade mínima/máxima do kit permitida por pedido. |\n| `supportedFulfillmentTypes` | `[FulfillmentType]!` | Tipos de atendimento suportados (`SHIPPING`, `NONE`). |\n| `shouldAppearInSitemap` | `Boolean` | Se o kit deve aparecer no sitemap gerado. |\n| `shop` | `Shop!` | Referência à loja à qual o kit pertence. |\n| `sortIndex` | `Int` | Índice de ordenação manual do kit em listagens. |\n| `currentProductHash` / `publishedProductHash` | `String` | Hashes para comparar se o kit mudou desde a última publicação. |\n| `publishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se nunca publicado. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização do kit. |\n| `measurementsInformation` | `String` | Informações de medidas (ex.: roupas, móveis). |\n| `originCountry` | `String` | País de origem do kit. |\n| `pageTitle` | `String` | Subtítulo do kit. |\n| `metaDescription` | `String` | Descrição usada na meta tag `description` da página do kit. |\n\n#### Campos de `kitComponents[]` (`ProductKitComponent`)\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------- | -------- | --------------------------------------------------------------------- |\n| `productTitle` | `String` | Título do produto original que originou o componente. |\n| `variantTitle` | `String` | Título da variante que compõe o kit. |\n| `price` | `Money` | Preço da variante componente. |\n| `label` | `String` | Rótulo que pode sobrescrever o título da variante na listagem do kit. |\n| `kitLabelImage` | `String` | URL de imagem usada como rótulo visual do componente. |\n| `productId` | `ID` | ID do produto original do componente. |\n| `productVariantId` | `ID` | ID da variante do componente. |\n| `productErpCode` / `variantErpCode` | `String` | Códigos ERP do produto/variante do componente, quando existirem. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `productKit: null`. Isso inclui passar o ID de um produto que não seja do tipo KIT — use `product` para esses.\n- **`kitComponents` pode vir incompleto silenciosamente.** Se um produto ou variante que compõe o kit foi excluído (ou não é mais encontrado por outro motivo), aquele componente simplesmente não aparece no array — a operação não lança erro nesse caso. Não assuma que o tamanho de `kitComponents` reflete exatamente a configuração original do kit; se precisar detectar essa divergência, compare com `requiredPicksPerGroup` e a quantidade de componentes esperada pelo seu catálogo interno."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"productKit\": {\n \"_id\": \"Example_ID\",\n \"requiredPicksPerGroup\": 10,\n \"titleLabel\": \"Example_String\",\n \"highlightLabel\": \"Example_String\",\n \"unitPriceLabel\": 99.99,\n \"kitGroupDescription\": \"Example_String\",\n \"price\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"compareAtPrice\": {\n \"amount\": 99.99,\n \"displayAmount\": 99.99\n },\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"currentProductHash\": \"Example_String\",\n \"description\": \"Example_String\",\n \"isDeleted\": true,\n \"isProductPublishable\": {\n \"isProductPublishable\": true\n },\n \"isVisible\": true,\n \"imageUrls\": [\n \"https://exemplo.com\"\n ],\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"media\": [\n {\n \"_id\": \"Example_ID\",\n \"priority\": 10,\n \"productId\": \"Example_ID\",\n \"variantId\": \"Example_ID\"\n }\n ],\n \"metaDescription\": \"Example_String\",\n \"metafields\": [\n {\n \"description\": \"Example_String\",\n \"key\": \"Example_String\",\n \"namespace\": \"Example_String\",\n \"scope\": \"Example_String\",\n \"value\": 99.99,\n \"valueType\": \"Example_String\"\n }\n ],\n \"measurementsInformation\": \"Example_String\",\n \"originCountry\": \"Example_String\",\n \"pageTitle\": \"Example_String\",\n \"type\": \"SIMPLE\",\n \"publishedAt\": \"2025-01-15T10:00:00Z\",\n \"publishedProductHash\": \"Example_String\",\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"shouldAppearInSitemap\": true,\n \"slug\": \"Example_String\",\n \"socialMetadata\": [\n {\n \"message\": \"Example_String\",\n \"service\": \"facebook\"\n }\n ],\n \"supportedFulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"tags\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n },\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"kitComponents\": [\n {\n \"productTitle\": \"Example_String\",\n \"variantTitle\": \"Example_String\",\n \"label\": \"Example_String\",\n \"kitLabelImage\": \"Example_String\",\n \"productId\": \"Example_ID\",\n \"productVariantId\": \"Example_ID\",\n \"productErpCode\": \"Example_String\",\n \"variantErpCode\": \"Example_String\"\n }\n ],\n \"vendor\": \"Example_String\",\n \"sortIndex\": 10,\n \"minOrderQuantity\": 10,\n \"maxOrderQuantity\": 10,\n \"unitPriceFactor\": 99.99,\n \"relatedInfo\": {\n \"title\": \"Example_String\",\n \"highlightLabel\": \"Example_String\",\n \"showUnitPrice\": 99.99\n }\n }\n }\n}"},{"id":"6f97df95-ad03-4bc8-b7fa-4de57a5c11de","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKit($productId: ID!) {\n productKit(productId: $productId) {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## productKit\n\n**Propósito:** Retorna um único produto do tipo KIT (combo com componentes obrigatórios) a partir do seu ID, com título, preço, mídia, tags e a lista de componentes.\n**Quando usar:** Para exibir a página de um kit específico ou consultar seus componentes antes de montar um carrinho. Para um item que não é kit, use `product`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto (kit) a consultar. |\n\n### Retorno\n\n`ProductKit`.\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do kit. |\n| `title` | `String` | Título do kit. |\n| `titleLabel` | `String` | Texto customizado de um rótulo exibido junto ao título. |\n| `description` | `String` | Descrição completa do kit (pode conter quebras de linha). |\n| `slug` | `String` | Identificador legível e único para URL. |\n| `type` | `ProductTypesEnum` | Sempre `KIT` para esta operação. |\n| `price` | `Money` | Preço do kit. |\n| `compareAtPrice` | `Money` | Preço \"de\" (comparação), quando aplicável. |\n| `erpCode` | `String` | Código do kit no ERP, se houver. |\n| `requiredPicksPerGroup` | `Int!` | Quantidade de escolhas obrigatórias por grupo de componentes para o kit poder ser adicionado a um carrinho. |\n| `kitComponents` | `[ProductKitComponent]!` | Componentes (produto + variante) que formam o kit. Ver tabela abaixo. Pode conter menos itens que a configuração original (ver Notas). |\n| `kitGroupDescription` | `String` | Texto descritivo da seção de componentes do kit. |\n| `highlightLabel` | `String` | Rótulo de destaque do kit em relação a outros. |\n| `unitPriceLabel` | `String` | Rótulo do que representa a unidade do kit (ex.: caixa, sabor, lata). |\n| `unitPriceFactor` | `Int` | Fator de divisão para calcular o preço por unidade do kit. |\n| `relatedInfo` | `ProductKitRelatedInfo` | Informações resumidas do kit (`title`, `highlightLabel`, `showUnitPrice`) usadas quando o kit é referenciado em outro contexto. |\n| `isVisible` | `Boolean!` | Se o kit deve ser exibido para compradores. |\n| `isDeleted` | `Boolean!` | Se o kit foi excluído (kits excluídos normalmente não são retornados pelas queries). |\n| `isProductPublishable` | `IsProductPublishable` | `isProductPublishable` (Boolean) + `errorsList` (`[{ message, path }]`) detalhando o que falta para o kit poder ser publicado. |\n| `imageUrls` / `videoUrls` | `[String]` | URLs de imagens/vídeos do kit. |\n| `media(shouldIncludeVariantMedia)` | `[ImageInfo]` | Mídia completa do kit (`URLs.large/medium/original/small/thumbnail`, `priority`). Por padrão (`shouldIncludeVariantMedia: true`) inclui também mídia das variantes componentes. |\n| `metafields` | `[Metafield]!` | Atributos customizados (`key`, `value`, `namespace`, `scope`, `valueType`, `description`). |\n| `socialMetadata` | `[SocialMetadata]` | Texto de compartilhamento sugerido por rede social (`message`, `service`). |\n| `tagIds` / `tags` | `[ID]` / `TagConnection` | IDs de tags associadas e a connection paginada correspondente. |\n| `vendor` | `String` | Fabricante/fornecedor do kit, para exibição. |\n| `minOrderQuantity` / `maxOrderQuantity` | `Int` | Quantidade mínima/máxima do kit permitida por pedido. |\n| `supportedFulfillmentTypes` | `[FulfillmentType]!` | Tipos de atendimento suportados (`SHIPPING`, `NONE`). |\n| `shouldAppearInSitemap` | `Boolean` | Se o kit deve aparecer no sitemap gerado. |\n| `shop` | `Shop!` | Referência à loja à qual o kit pertence. |\n| `sortIndex` | `Int` | Índice de ordenação manual do kit em listagens. |\n| `currentProductHash` / `publishedProductHash` | `String` | Hashes para comparar se o kit mudou desde a última publicação. |\n| `publishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se nunca publicado. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização do kit. |\n| `measurementsInformation` | `String` | Informações de medidas (ex.: roupas, móveis). |\n| `originCountry` | `String` | País de origem do kit. |\n| `pageTitle` | `String` | Subtítulo do kit. |\n| `metaDescription` | `String` | Descrição usada na meta tag `description` da página do kit. |\n\n#### Campos de `kitComponents[]` (`ProductKitComponent`)\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------- | -------- | --------------------------------------------------------------------- |\n| `productTitle` | `String` | Título do produto original que originou o componente. |\n| `variantTitle` | `String` | Título da variante que compõe o kit. |\n| `price` | `Money` | Preço da variante componente. |\n| `label` | `String` | Rótulo que pode sobrescrever o título da variante na listagem do kit. |\n| `kitLabelImage` | `String` | URL de imagem usada como rótulo visual do componente. |\n| `productId` | `ID` | ID do produto original do componente. |\n| `productVariantId` | `ID` | ID da variante do componente. |\n| `productErpCode` / `variantErpCode` | `String` | Códigos ERP do produto/variante do componente, quando existirem. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `productKit: null`. Isso inclui passar o ID de um produto que não seja do tipo KIT — use `product` para esses.\n- **`kitComponents` pode vir incompleto silenciosamente.** Se um produto ou variante que compõe o kit foi excluído (ou não é mais encontrado por outro motivo), aquele componente simplesmente não aparece no array — a operação não lança erro nesse caso. Não assuma que o tamanho de `kitComponents` reflete exatamente a configuração original do kit; se precisar detectar essa divergência, compare com `requiredPicksPerGroup` e a quantidade de componentes esperada pelo seu catálogo interno."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"5935583f-2f32-4312-a4d6-8e190fe12646","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKit($productId: ID!) {\n productKit(productId: $productId) {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n}","variables":"{\n \"productId\": \"{{productId}}\"\n}"}},"url":"{{base_url}}","description":"## productKit\n\n**Propósito:** Retorna um único produto do tipo KIT (combo com componentes obrigatórios) a partir do seu ID, com título, preço, mídia, tags e a lista de componentes.\n**Quando usar:** Para exibir a página de um kit específico ou consultar seus componentes antes de montar um carrinho. Para um item que não é kit, use `product`.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------- | ----- | ----------- | ------- | -------------------------------- |\n| `productId` | `ID!` | Sim | — | ID do produto (kit) a consultar. |\n\n### Retorno\n\n`ProductKit`.\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `ID!` | ID do kit. |\n| `title` | `String` | Título do kit. |\n| `titleLabel` | `String` | Texto customizado de um rótulo exibido junto ao título. |\n| `description` | `String` | Descrição completa do kit (pode conter quebras de linha). |\n| `slug` | `String` | Identificador legível e único para URL. |\n| `type` | `ProductTypesEnum` | Sempre `KIT` para esta operação. |\n| `price` | `Money` | Preço do kit. |\n| `compareAtPrice` | `Money` | Preço \"de\" (comparação), quando aplicável. |\n| `erpCode` | `String` | Código do kit no ERP, se houver. |\n| `requiredPicksPerGroup` | `Int!` | Quantidade de escolhas obrigatórias por grupo de componentes para o kit poder ser adicionado a um carrinho. |\n| `kitComponents` | `[ProductKitComponent]!` | Componentes (produto + variante) que formam o kit. Ver tabela abaixo. Pode conter menos itens que a configuração original (ver Notas). |\n| `kitGroupDescription` | `String` | Texto descritivo da seção de componentes do kit. |\n| `highlightLabel` | `String` | Rótulo de destaque do kit em relação a outros. |\n| `unitPriceLabel` | `String` | Rótulo do que representa a unidade do kit (ex.: caixa, sabor, lata). |\n| `unitPriceFactor` | `Int` | Fator de divisão para calcular o preço por unidade do kit. |\n| `relatedInfo` | `ProductKitRelatedInfo` | Informações resumidas do kit (`title`, `highlightLabel`, `showUnitPrice`) usadas quando o kit é referenciado em outro contexto. |\n| `isVisible` | `Boolean!` | Se o kit deve ser exibido para compradores. |\n| `isDeleted` | `Boolean!` | Se o kit foi excluído (kits excluídos normalmente não são retornados pelas queries). |\n| `isProductPublishable` | `IsProductPublishable` | `isProductPublishable` (Boolean) + `errorsList` (`[{ message, path }]`) detalhando o que falta para o kit poder ser publicado. |\n| `imageUrls` / `videoUrls` | `[String]` | URLs de imagens/vídeos do kit. |\n| `media(shouldIncludeVariantMedia)` | `[ImageInfo]` | Mídia completa do kit (`URLs.large/medium/original/small/thumbnail`, `priority`). Por padrão (`shouldIncludeVariantMedia: true`) inclui também mídia das variantes componentes. |\n| `metafields` | `[Metafield]!` | Atributos customizados (`key`, `value`, `namespace`, `scope`, `valueType`, `description`). |\n| `socialMetadata` | `[SocialMetadata]` | Texto de compartilhamento sugerido por rede social (`message`, `service`). |\n| `tagIds` / `tags` | `[ID]` / `TagConnection` | IDs de tags associadas e a connection paginada correspondente. |\n| `vendor` | `String` | Fabricante/fornecedor do kit, para exibição. |\n| `minOrderQuantity` / `maxOrderQuantity` | `Int` | Quantidade mínima/máxima do kit permitida por pedido. |\n| `supportedFulfillmentTypes` | `[FulfillmentType]!` | Tipos de atendimento suportados (`SHIPPING`, `NONE`). |\n| `shouldAppearInSitemap` | `Boolean` | Se o kit deve aparecer no sitemap gerado. |\n| `shop` | `Shop!` | Referência à loja à qual o kit pertence. |\n| `sortIndex` | `Int` | Índice de ordenação manual do kit em listagens. |\n| `currentProductHash` / `publishedProductHash` | `String` | Hashes para comparar se o kit mudou desde a última publicação. |\n| `publishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se nunca publicado. |\n| `createdAt` / `updatedAt` | `AWSDateTime!` / `AWSDateTime` | Datas de criação/atualização do kit. |\n| `measurementsInformation` | `String` | Informações de medidas (ex.: roupas, móveis). |\n| `originCountry` | `String` | País de origem do kit. |\n| `pageTitle` | `String` | Subtítulo do kit. |\n| `metaDescription` | `String` | Descrição usada na meta tag `description` da página do kit. |\n\n#### Campos de `kitComponents[]` (`ProductKitComponent`)\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------- | -------- | --------------------------------------------------------------------- |\n| `productTitle` | `String` | Título do produto original que originou o componente. |\n| `variantTitle` | `String` | Título da variante que compõe o kit. |\n| `price` | `Money` | Preço da variante componente. |\n| `label` | `String` | Rótulo que pode sobrescrever o título da variante na listagem do kit. |\n| `kitLabelImage` | `String` | URL de imagem usada como rótulo visual do componente. |\n| `productId` | `ID` | ID do produto original do componente. |\n| `productVariantId` | `ID` | ID da variante do componente. |\n| `productErpCode` / `variantErpCode` | `String` | Códigos ERP do produto/variante do componente, quando existirem. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. Esta operação não tem outros códigos de erro de negócio conhecidos.\n\n### Notas\n\n- **`productId` inexistente (ou de outra loja/tipo) não gera erro.** A resposta é `productKit: null`. Isso inclui passar o ID de um produto que não seja do tipo KIT — use `product` para esses.\n- **`kitComponents` pode vir incompleto silenciosamente.** Se um produto ou variante que compõe o kit foi excluído (ou não é mais encontrado por outro motivo), aquele componente simplesmente não aparece no array — a operação não lança erro nesse caso. Não assuma que o tamanho de `kitComponents` reflete exatamente a configuração original do kit; se precisar detectar essa divergência, compare com `requiredPicksPerGroup` e a quantidade de componentes esperada pelo seu catálogo interno."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"21b74673-fdcb-57de-9b4f-89108a952adb"},{"name":"[Query] productKits","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns productKits data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"productKits\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"productKits returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.productKits;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"3021b286-d351-5e92-a7ab-e8767198b4f5","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKits($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n productKits(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n }\n nodes {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"productKits
\nPropósito: Lista, com paginação, os produtos do tipo KIT da sua loja, com os mesmos filtros de arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual disponíveis em products.\nQuando usar: Para montar ou sincronizar uma listagem de kits/combos no seu canal, ou buscar kits por texto/tag/metafield antes de decidir quais exibir. Para um único kit já conhecido, prefira productKit, que evita o overhead de paginação.\nAutenticação: x-api-key + Authorization. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.
\nArgumentos
\nTodos os argumentos são opcionais e combináveis. Ver a seção Paginação Relay no folder deste domínio para os argumentos de paginação.
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nisArchived | \nBoolean | \nNão | \nnull (sem filtro) | \nFiltra por kits arquivados (true) ou não arquivados (false). | \n
\n\nisVisible | \nBoolean | \nNão | \nnull (sem filtro) | \nFiltra por kits visíveis (true) ou ocultos (false) na loja. | \n
\n\nmetafieldKey | \nString | \nNão | \nnull | \nFiltra por kits que tenham um metafield com esta chave. Combine com metafieldValue. | \n
\n\nmetafieldValue | \nString | \nNão | \nnull | \nFiltra por kits que tenham um metafield com este valor. Combine com metafieldKey. | \n
\n\npriceMin | \nFloat | \nNão | \nnull | \nPreço mínimo do kit. | \n
\n\npriceMax | \nFloat | \nNão | \nnull | \nPreço máximo do kit. | \n
\n\nproductIds | \n[ID] | \nNão | \nnull | \nLista de IDs de kit para restringir o resultado a esse conjunto específico. | \n
\n\nquery | \nString | \nNão | \nnull | \nBusca textual (regex) livre sobre o kit. | \n
\n\ntagIds | \n[ID] | \nNão | \nnull | \nLista de IDs de tag para filtrar kits associados a qualquer uma delas. | \n
\n\nafter | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \nnull | \nCursor de paginação — retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar. Use com after ou offset. | \n
\n\nlast | \nInt | \nNão | \nnull | \nQuantidade máxima de resultados a retornar, a partir do fim. Use com before (não combine com offset). | \n
\n\noffset | \nInt | \nNão | \nnull | \nPula os N primeiros resultados. Use com first (não combine com last). | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nDireção da ordenação (asc/desc). | \n
\n\nsortBy | \nProductSortByField | \nNão | \ncreatedAt | \nCampo de ordenação (_id, createdAt, title, updatedAt). | \n
\n\n
\n
Retorno
\nProductKitConnection — uma connection Relay (ver Paginação Relay no folder deste domínio). Cada nó é um ProductKit completo (mesma forma retornada por productKit — título, preço, kitComponents, requiredPicksPerGroup, mídia, tags etc.).
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nedges[].cursor | \nString! | \nCursor do item, usado com after/before para paginar. | \n
\n\nedges[].node | \nProductKit | \nO kit em si. Ver a operação productKit para o detalhamento completo dos campos. | \n
\n\nnodes | \n[ProductKit] | \nAtalho com os kits diretamente, sem o wrapper de cursor de edges. | \n
\n\npageInfo.hasNextPage | \nBoolean! | \nSe há mais resultados após a página atual. | \n
\n\npageInfo.hasPreviousPage | \nBoolean! | \nSe há resultados antes da página atual. | \n
\n\npageInfo.startCursor | \nString | \nCursor do primeiro item da página atual. | \n
\n\npageInfo.endCursor | \nString | \nCursor do último item da página atual. | \n
\n\ntotalCount | \nInt! | \nTotal de kits que atendem aos filtros, independente da paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nArgumentos last e offset enviados juntos. | \nErro de validação com mensagem descritiva, sem extensions.code estável. Envie apenas um dos dois esquemas de paginação por chamada. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio.
\n
\nNotas
\n\n- Sem filtros, esta operação retorna todos os kits elegíveis da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de
totalCount sozinho para decidir o volume de chamadas. \nquery faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal.- Assim como em
productKit, o campo kitComponents de cada nó pode vir com menos itens do que a configuração original do kit, sem gerar erro, quando um componente foi excluído (ver Notas de productKit). \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5252fa77-0344-4d53-9651-c6951fac4339","name":"200 - productKits","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKits($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n productKits(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n }\n nodes {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## productKits\n\n**Propósito:** Lista, com paginação, os produtos do tipo KIT da sua loja, com os mesmos filtros de arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual disponíveis em `products`.\n**Quando usar:** Para montar ou sincronizar uma listagem de kits/combos no seu canal, ou buscar kits por texto/tag/metafield antes de decidir quais exibir. Para um único kit já conhecido, prefira `productKit`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por kits que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por kits que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do kit. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do kit. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de kit para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o kit. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar kits associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductKitConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `ProductKit` completo (mesma forma retornada por `productKit` — título, preço, `kitComponents`, `requiredPicksPerGroup`, mídia, tags etc.).\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | -------------- | --------------------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductKit` | O kit em si. Ver a operação `productKit` para o detalhamento completo dos campos. |\n| `nodes` | `[ProductKit]` | Atalho com os kits diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de kits que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todos os kits elegíveis da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal.\n- Assim como em `productKit`, o campo `kitComponents` de cada nó pode vir com menos itens do que a configuração original do kit, sem gerar erro, quando um componente foi excluído (ver Notas de `productKit`)."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"productKits\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"requiredPicksPerGroup\": 10,\n \"titleLabel\": \"Example_String\",\n \"highlightLabel\": \"Example_String\",\n \"unitPriceLabel\": 99.99,\n \"kitGroupDescription\": \"Example_String\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"currentProductHash\": \"Example_String\",\n \"description\": \"Example_String\",\n \"isDeleted\": true,\n \"isVisible\": true,\n \"imageUrls\": [\n \"https://exemplo.com\"\n ],\n \"videoUrls\": [\n \"https://exemplo.com\"\n ],\n \"metaDescription\": \"Example_String\",\n \"measurementsInformation\": \"Example_String\",\n \"originCountry\": \"Example_String\",\n \"pageTitle\": \"Example_String\",\n \"type\": \"SIMPLE\",\n \"publishedAt\": \"2025-01-15T10:00:00Z\",\n \"publishedProductHash\": \"Example_String\",\n \"shouldAppearInSitemap\": true,\n \"slug\": \"Example_String\",\n \"supportedFulfillmentTypes\": [\n \"SHIPPING\"\n ],\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"title\": \"Example_String\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"vendor\": \"Example_String\",\n \"sortIndex\": 10,\n \"minOrderQuantity\": 10,\n \"maxOrderQuantity\": 10,\n \"unitPriceFactor\": 99.99\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"4c5d4c6e-4638-4c9c-9c0a-d39858a91449","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKits($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n productKits(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n }\n nodes {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## productKits\n\n**Propósito:** Lista, com paginação, os produtos do tipo KIT da sua loja, com os mesmos filtros de arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual disponíveis em `products`.\n**Quando usar:** Para montar ou sincronizar uma listagem de kits/combos no seu canal, ou buscar kits por texto/tag/metafield antes de decidir quais exibir. Para um único kit já conhecido, prefira `productKit`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por kits que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por kits que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do kit. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do kit. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de kit para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o kit. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar kits associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductKitConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `ProductKit` completo (mesma forma retornada por `productKit` — título, preço, `kitComponents`, `requiredPicksPerGroup`, mídia, tags etc.).\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | -------------- | --------------------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductKit` | O kit em si. Ver a operação `productKit` para o detalhamento completo dos campos. |\n| `nodes` | `[ProductKit]` | Atalho com os kits diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de kits que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todos os kits elegíveis da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal.\n- Assim como em `productKit`, o campo `kitComponents` de cada nó pode vir com menos itens do que a configuração original do kit, sem gerar erro, quando um componente foi excluído (ver Notas de `productKit`)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"baab18cc-b857-4771-8886-dda2c98f10a0","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ProductKits($isArchived: Boolean, $isVisible: Boolean, $metafieldKey: String, $metafieldValue: String, $priceMax: Float, $priceMin: Float, $productIds: [ID], $query: String, $tagIds: [ID], $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: ProductSortByField) {\n productKits(isArchived: $isArchived, isVisible: $isVisible, metafieldKey: $metafieldKey, metafieldValue: $metafieldValue, priceMax: $priceMax, priceMin: $priceMin, productIds: $productIds, query: $query, tagIds: $tagIds, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n }\n nodes {\n _id\n requiredPicksPerGroup\n titleLabel\n highlightLabel\n unitPriceLabel\n kitGroupDescription\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n compareAtPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n erpCode\n createdAt\n currentProductHash\n description\n isDeleted\n isProductPublishable {\n isProductPublishable\n errorsList {\n message\n path\n }\n }\n isVisible\n imageUrls\n videoUrls\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n measurementsInformation\n originCountry\n pageTitle\n type\n publishedAt\n publishedProductHash\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n shouldAppearInSitemap\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n title\n updatedAt\n kitComponents {\n productTitle\n variantTitle\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n label\n kitLabelImage\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n vendor\n sortIndex\n minOrderQuantity\n maxOrderQuantity\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"isArchived\": true,\n \"isVisible\": true,\n \"metafieldKey\": \"Example_String\",\n \"metafieldValue\": \"Example_String\",\n \"priceMax\": 99.99,\n \"priceMin\": 99.99,\n \"productIds\": [\n \"Example_ID\"\n ],\n \"query\": \"Example_String\",\n \"tagIds\": [\n \"Example_ID\"\n ],\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## productKits\n\n**Propósito:** Lista, com paginação, os produtos do tipo KIT da sua loja, com os mesmos filtros de arquivamento, visibilidade, faixa de preço, tags, metafield e busca textual disponíveis em `products`.\n**Quando usar:** Para montar ou sincronizar uma listagem de kits/combos no seu canal, ou buscar kits por texto/tag/metafield antes de decidir quais exibir. Para um único kit já conhecido, prefira `productKit`, que evita o overhead de paginação.\n**Autenticação:** `x-api-key` + `Authorization`. Os resultados são sempre escopados à loja da conta autenticada; não há argumento de loja nesta operação.\n\n### Argumentos\n\nTodos os argumentos são opcionais e combináveis. Ver a seção **Paginação Relay** no folder deste domínio para os argumentos de paginação.\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ---------------- | -------------------- | ----------- | ------------------- | --------------------------------------------------------------------------------------------------------- |\n| `isArchived` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits arquivados (`true`) ou não arquivados (`false`). |\n| `isVisible` | `Boolean` | Não | `null` (sem filtro) | Filtra por kits visíveis (`true`) ou ocultos (`false`) na loja. |\n| `metafieldKey` | `String` | Não | `null` | Filtra por kits que tenham um metafield com esta chave. Combine com `metafieldValue`. |\n| `metafieldValue` | `String` | Não | `null` | Filtra por kits que tenham um metafield com este valor. Combine com `metafieldKey`. |\n| `priceMin` | `Float` | Não | `null` | Preço mínimo do kit. |\n| `priceMax` | `Float` | Não | `null` | Preço máximo do kit. |\n| `productIds` | `[ID]` | Não | `null` | Lista de IDs de kit para restringir o resultado a esse conjunto específico. |\n| `query` | `String` | Não | `null` | Busca textual (regex) livre sobre o kit. |\n| `tagIds` | `[ID]` | Não | `null` | Lista de IDs de tag para filtrar kits associados a qualquer uma delas. |\n| `after` | `String` | Não | `null` | Cursor de paginação — retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor de paginação — retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar. Use com `after` ou `offset`. |\n| `last` | `Int` | Não | `null` | Quantidade máxima de resultados a retornar, a partir do fim. Use com `before` (não combine com `offset`). |\n| `offset` | `Int` | Não | `null` | Pula os N primeiros resultados. Use com `first` (não combine com `last`). |\n| `sortOrder` | `SortOrder` | Não | `desc` | Direção da ordenação (`asc`/`desc`). |\n| `sortBy` | `ProductSortByField` | Não | `createdAt` | Campo de ordenação (`_id`, `createdAt`, `title`, `updatedAt`). |\n\n### Retorno\n\n`ProductKitConnection` — uma connection Relay (ver **Paginação Relay** no folder deste domínio). Cada nó é um `ProductKit` completo (mesma forma retornada por `productKit` — título, preço, `kitComponents`, `requiredPicksPerGroup`, mídia, tags etc.).\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | -------------- | --------------------------------------------------------------------------------- |\n| `edges[].cursor` | `String!` | Cursor do item, usado com `after`/`before` para paginar. |\n| `edges[].node` | `ProductKit` | O kit em si. Ver a operação `productKit` para o detalhamento completo dos campos. |\n| `nodes` | `[ProductKit]` | Atalho com os kits diretamente, sem o wrapper de cursor de `edges`. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após a página atual. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes da página atual. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página atual. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página atual. |\n| `totalCount` | `Int!` | Total de kits que atendem aos filtros, independente da paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | Argumentos `last` e `offset` enviados juntos. | Erro de validação com mensagem descritiva, sem `extensions.code` estável. Envie apenas um dos dois esquemas de paginação por chamada. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Sem filtros, esta operação retorna todos os kits elegíveis da loja, sujeito à paginação — em lojas grandes, sempre pagine e evite depender de `totalCount` sozinho para decidir o volume de chamadas.\n- `query` faz correspondência via regex — caracteres especiais de regex no texto de busca podem ter efeito inesperado; escape-os se buscar por texto literal.\n- Assim como em `productKit`, o campo `kitComponents` de cada nó pode vir com menos itens do que a configuração original do kit, sem gerar erro, quando um componente foi excluído (ver Notas de `productKit`)."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"3021b286-d351-5e92-a7ab-e8767198b4f5"}],"id":"89d4c747-c6d7-4682-872d-22659bdc3663","_postman_id":"89d4c747-c6d7-4682-872d-22659bdc3663","description":""}],"id":"e7f05eee-1847-4a6a-9dc7-eec2f44cc8d6","description":"Produtos
\nConsultas de catálogo para itens individuais e kits: product/products cobrem produtos do tipo SIMPLE, VARIANT e OPTION; productKit/productKits cobrem produtos do tipo KIT (combos com componentes obrigatórios). As quatro operações são somente leitura e sempre escopadas à loja da conta autenticada — não existe um parâmetro de loja nestas operações, então não tente enviá-lo.
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores/Campos | \nDescrição | \n
\n\n\n\nProductTypesEnum | \nSIMPLE, VARIANT, OPTION, KIT | \nDefine o comportamento do produto. product/products filtram implicitamente por SIMPLE/VARIANT/OPTION; productKit/productKits filtram implicitamente por KIT. Você não escolhe o tipo via argumento — a query já determina o filtro. | \n
\n\nProductSortByField | \n_id, createdAt, title, updatedAt | \nCampo de ordenação das listagens (products, productKits). Se omitido, a ordenação padrão é por createdAt. | \n
\n\nSortOrder | \nasc, desc | \nDireção da ordenação. Se omitido, o padrão é desc. | \n
\n\nFulfillmentType | \nSHIPPING, NONE | \nTipos de atendimento disponíveis para o produto (usado em supportedFulfillmentTypes de kits). | \n
\n\nMoney | \namount, currency, displayAmount | \nValor monetário simples (usado, por exemplo, em ProductKit.price/compareAtPrice e nos itens de kitComponents). | \n
\n\nCurrency | \ncode, symbol, format, decimal, thousand, scale, rate | \nMetadados de exibição/formatação da moeda associada a um valor de preço. | \n
\n\nImageInfo/ImageSizes | \nURLs (large, medium, original, small, thumbnail), priority, productId, variantId | \nEstrutura de mídia retornada pelo campo media dos kits, com uma URL por resolução. | \n
\n\nMetafield | \nkey, value, namespace, scope, valueType, description | \nAtributo customizado livre associado ao produto/kit. | \n
\n\nSocialMetadata | \nmessage, service (SocialNetwork: facebook, googleplus, pinterest, twitter) | \nTexto de compartilhamento sugerido por rede social. | \n
\n\nIsProductPublishable | \nisProductPublishable (Boolean), errorsList ([ErrorsListItem]: message, path) | \nResultado da validação de publicabilidade do kit — se false, errorsList detalha o que falta corrigir. | \n
\n\n
\n
Regras de negócio
\n\n- Item não encontrado retorna
null, não erro. Em product e productKit, um productId inexistente (ou de outra loja, ou de outro tipo — por exemplo, passar o ID de um KIT para product) resulta em resposta null no campo, sem entrar em errors[]. \n- Paginação Relay (
products, productKits). Ambas retornam uma connection com edges ({ cursor, node }), nodes (atalho sem o wrapper de cursor), pageInfo (hasNextPage, hasPreviousPage, startCursor, endCursor) e totalCount. Para avançar página, envie first + after: <pageInfo.endCursor>; para retroceder, last + before: <pageInfo.startCursor>. Alternativamente, offset pagina por deslocamento numérico em vez de cursor. \n- Não combine
last com offset. Enviar as duas juntas causa um erro de validação (mensagem descritiva, sem extensions.code estável) — escolha um dos dois esquemas de paginação por chamada. \n- Filtros de
products/productKits são todos opcionais e combináveis (isArchived, isVisible, productIds, tagIds, priceMin/priceMax, metafieldKey/metafieldValue, query como busca textual). Omitir todos retorna o catálogo completo do tipo correspondente, sujeito à paginação. \nkitComponents de um productKit/productKits pode retornar menos itens do que o kit tem cadastrado internamente. Se um produto ou variante componente do kit foi excluído ou não é mais encontrado, aquele componente é omitido do array silenciosamente (sem erro) — não assuma que o tamanho de kitComponents corresponde exatamente à configuração original do kit.product retorna apenas dados de preço. O tipo retornado por product/products expõe somente price e pricing — não inclui título, mídia, slug ou outros dados de exibição. Para essas informações de exibição, use productKit/productKits (quando o item for um kit) ou a query productGroup/productGroups do catálogo.
\n","_postman_id":"e7f05eee-1847-4a6a-9dc7-eec2f44cc8d6"},{"name":"Recurring Orders","item":[{"name":"Query","item":[{"name":"[Query] shopRecurringOrders","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns shopRecurringOrders data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"shopRecurringOrders\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"shopRecurringOrders returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.shopRecurringOrders;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"a3712094-3b90-5319-bd38-2ac41a72815f","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrders($filters: ShopRecurringOrdersFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrdersSortByField) {\n shopRecurringOrders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n cycleIndex\n items {\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n skipped\n status\n quantity\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n }\n error {\n createdAt\n createdBy\n triggeredBy\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n metaDescription\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n productId\n type\n productType\n recurrenceAllowed\n sku\n slug\n supportedFulfillmentTypes\n title\n updatedAt\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n isBackorder\n isLowQuantity\n isSoldOut\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n displayAmount\n }\n cyclePrice {\n amount\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"status\": [\n \"ACTIVE\"\n ],\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"shopRecurringOrders
\nPropósito: Lista as assinaturas (recurring orders) da loja autenticada, com filtros por status e por período de criação.\nQuando usar: Para acompanhar a carteira de assinaturas — ativas, pausadas, canceladas ou em erro. É o ponto de entrada do domínio: a partir do _id retornado aqui você consulta o histórico de ciclos com shopRecurringOrderCycles.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — não há argumento de loja nesta query.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nShopRecurringOrdersFilterInput | \nNão | \nnull | \nFiltros da listagem. Omitido, retorna todas as assinaturas da loja. | \n
\n\nfilters.status | \n[RecurringOrderStatusEnum] | \nNão | \n— | \nFiltra por uma lista de status (ACTIVE, CANCELED, PAUSED, ERROR) — combina com \"ou\": qualquer assinatura cujo status esteja na lista é retornada. | \n
\n\nfilters.createdAt | \nDateFilterInput | \nNão | \n— | \nFiltra por período de criação: { gte: AWSDateTime, lte: AWSDateTime }, ambos opcionais e combináveis. | \n
\n\nafter | \nString | \nNão | \nnull | \nCursor Relay: retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \nnull | \nCursor Relay: retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Usado com after ou offset. | \n
\n\nlast | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Usado com before. | \n
\n\noffset | \nInt | \nNão | \n— | \nRetorna resultados a partir do N-ésimo item. Alternativa a after baseada em posição. | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nOrdem de classificação: asc ou desc. | \n
\n\nsortBy | \nRecurringOrdersSortByField | \nNão | \ncreatedAt | \nCampo de ordenação. Único valor disponível hoje: createdAt. | \n
\n\n
\n
Retorno
\nRecurringOrderConnection! — conexão Relay (ver paginação no folder). Cada node é uma RecurringOrder:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes[]._id | \nID! | \nIdentificador da assinatura. Use este valor no filtro recurringOrderId de shopRecurringOrderCycles. | \n
\n\nnodes[].referenceId | \nString! | \nIdentificador amigável da assinatura. | \n
\n\nnodes[].customerAccountId | \nString! | \nConta do cliente dono da assinatura. | \n
\n\nnodes[].createdAt / updatedAt | \nAWSDateTime! | \nDatas de criação e última atualização. | \n
\n\nnodes[].status | \nRecurringOrderStatus! | \nStatus da assinatura. value (ACTIVE/CANCELED/PAUSED/ERROR) traz o status atual; createdAt/createdBy/triggeredBy descrevem quando e por quem essa transição ocorreu. | \n
\n\nnodes[].status.history[] | \nRecurringOrderStatusHistory | \nHistórico de mudanças de status, cada item com value, createdAt, triggeredBy. | \n
\n\nnodes[].unboxPayCustomerId | \nString! | \nIdentificador do cliente no Unbox Pay, usado para vincular a cobrança recorrente. | \n
\n\nnodes[].frequency | \nRecurringOrderFrequency! | \nFrequência de recorrência: _id, title (rótulo), periodicity (DAY/WEEK/MONTH) e interval (multiplicador da periodicidade). | \n
\n\nnodes[].pricingPolicy | \nRecurringOrderPricingPolicy! | \nPolítica de preço aplicada aos ciclos: type (PERCENTAGE_OFF/AMOUNT_OFF/NONE) e value. | \n
\n\nnodes[].cyclesInformation.cycleCount | \nInt! | \nTotal de ciclos já gerados para esta assinatura. | \n
\n\nnodes[].cyclesInformation.skipNextCycle | \nBoolean! | \nSe true, o próximo ciclo será pulado automaticamente. | \n
\n\nnodes[].cyclesInformation.lastCycleDate | \nAWSDateTime | \nData do último ciclo gerado. null se nenhum ciclo foi gerado ainda. | \n
\n\nnodes[].cyclesInformation.nextCycleDate | \nAWSDateTime | \nData prevista do próximo ciclo. | \n
\n\nnodes[].cyclesInformation.currentCycle | \nRecurringOrderCycle | \nResumo do ciclo em andamento/mais recente. Para o histórico completo, use shopRecurringOrderCycles. | \n
\n\nnodes[].items[] | \n[RecurringOrderItem]! | \nItens que compõem cada novo ciclo: productId/variantId/productKitId e os códigos de ERP correspondentes (productERPCode, variantERPCode), productKitItemsConfigurations (configuração de cada componente, para itens do tipo kit), quantity, price, skipNextCycle e catalogProduct (dados do catálogo). | \n
\n\nnodes[].discount | \nRecurringOrderDiscountData | \nCupom de desconto aplicado à assinatura (discountId, code). null se nenhum cupom foi usado. | \n
\n\nnodes[].unboxPayCustomerCreditCard | \nRecurringOrderCreditCard! | \nCartão usado para cobrança: last4Digits (sempre presente), first4Digits/first6Digits (nem sempre presentes), expirationMonth, expirationYear, holderName. Nunca traz o número completo do cartão. | \n
\n\nnodes[].shippingAddressBook | \nAddress | \nEndereço de entrega configurado para a assinatura. null se não houver um definido. | \n
\n\nnodes[].totalAmount | \nMoney! | \nEstimativa do valor do próximo ciclo (amount decimal, currency, displayAmount já formatado), calculada a partir dos preços de catálogo dos itens. É aproximado — pode incluir itens que serão pulados ou que estão fora de estoque. Para o valor efetivamente cobrado, use o totalAmount do ciclo em shopRecurringOrderCycles (ou cyclesInformation.currentCycle.totalAmount). | \n
\n\npageInfo / totalCount | \nPageInfo! / Int! | \nMetadados de paginação Relay — ver folder. | \n
\n\n
\n
Erros
\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (access_token ausente, inválido ou expirado) seguem o padrão geral descrito na Overview.
\n\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo aqui.
\n
\nNotas
\n\n- Filtro por status é uma lista (\"ou\"), não um valor único. Envie
filters.status: [ACTIVE, PAUSED] para trazer assinaturas em qualquer um desses status. \nfilters.createdAt.gte/lte são independentes e combináveis — envie só um dos dois para um filtro \"a partir de\" ou \"até\", ou ambos para um intervalo fechado.- Sem
filters, a chamada retorna todas as assinaturas da loja, independente de status. \n- Ordenação hoje é fixa por
createdAt — o enum RecurringOrdersSortByField só expõe esse valor; o argumento existe para compatibilidade futura. \ncyclesInformation.currentCycle é apenas um resumo do ciclo mais recente/atual; para navegar por todos os ciclos (incluindo os concluídos), use shopRecurringOrderCycles com o _id desta assinatura.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7c038929-edbc-43fe-bafe-a0985f7c5d3e","name":"200 - shopRecurringOrders","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrders($filters: ShopRecurringOrdersFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrdersSortByField) {\n shopRecurringOrders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n cycleIndex\n items {\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n skipped\n status\n quantity\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n }\n error {\n createdAt\n createdBy\n triggeredBy\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n metaDescription\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n productId\n type\n productType\n recurrenceAllowed\n sku\n slug\n supportedFulfillmentTypes\n title\n updatedAt\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n isBackorder\n isLowQuantity\n isSoldOut\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n displayAmount\n }\n cyclePrice {\n amount\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"status\": [\n \"ACTIVE\"\n ],\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrders\n\n**Propósito:** Lista as assinaturas (recurring orders) da loja autenticada, com filtros por status e por período de criação.\n**Quando usar:** Para acompanhar a carteira de assinaturas — ativas, pausadas, canceladas ou em erro. É o ponto de entrada do domínio: a partir do `_id` retornado aqui você consulta o histórico de ciclos com `shopRecurringOrderCycles`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não há argumento de loja nesta query.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | -------------------------------- | ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `filters` | `ShopRecurringOrdersFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todas as assinaturas da loja. |\n| `filters.status` | `[RecurringOrderStatusEnum]` | Não | — | Filtra por uma lista de status (`ACTIVE`, `CANCELED`, `PAUSED`, `ERROR`) — combina com \"ou\": qualquer assinatura cujo status esteja na lista é retornada. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por período de criação: `{ gte: AWSDateTime, lte: AWSDateTime }`, ambos opcionais e combináveis. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrdersSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderConnection!` — conexão Relay (ver paginação no folder). Cada `node` é uma `RecurringOrder`:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `nodes[]._id` | `ID!` | Identificador da assinatura. Use este valor no filtro `recurringOrderId` de `shopRecurringOrderCycles`. |\n| `nodes[].referenceId` | `String!` | Identificador amigável da assinatura. |\n| `nodes[].customerAccountId` | `String!` | Conta do cliente dono da assinatura. |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização. |\n| `nodes[].status` | `RecurringOrderStatus!` | Status da assinatura. `value` (`ACTIVE`/`CANCELED`/`PAUSED`/`ERROR`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].unboxPayCustomerId` | `String!` | Identificador do cliente no Unbox Pay, usado para vincular a cobrança recorrente. |\n| `nodes[].frequency` | `RecurringOrderFrequency!` | Frequência de recorrência: `_id`, `title` (rótulo), `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval` (multiplicador da periodicidade). |\n| `nodes[].pricingPolicy` | `RecurringOrderPricingPolicy!` | Política de preço aplicada aos ciclos: `type` (`PERCENTAGE_OFF`/`AMOUNT_OFF`/`NONE`) e `value`. |\n| `nodes[].cyclesInformation.cycleCount` | `Int!` | Total de ciclos já gerados para esta assinatura. |\n| `nodes[].cyclesInformation.skipNextCycle` | `Boolean!` | Se `true`, o próximo ciclo será pulado automaticamente. |\n| `nodes[].cyclesInformation.lastCycleDate` | `AWSDateTime` | Data do último ciclo gerado. `null` se nenhum ciclo foi gerado ainda. |\n| `nodes[].cyclesInformation.nextCycleDate` | `AWSDateTime` | Data prevista do próximo ciclo. |\n| `nodes[].cyclesInformation.currentCycle` | `RecurringOrderCycle` | Resumo do ciclo em andamento/mais recente. Para o histórico completo, use `shopRecurringOrderCycles`. |\n| `nodes[].items[]` | `[RecurringOrderItem]!` | Itens que compõem cada novo ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `quantity`, `price`, `skipNextCycle` e `catalogProduct` (dados do catálogo). |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado à assinatura (`discountId`, `code`). `null` se nenhum cupom foi usado. |\n| `nodes[].unboxPayCustomerCreditCard` | `RecurringOrderCreditCard!` | Cartão usado para cobrança: `last4Digits` (sempre presente), `first4Digits`/`first6Digits` (nem sempre presentes), `expirationMonth`, `expirationYear`, `holderName`. Nunca traz o número completo do cartão. |\n| `nodes[].shippingAddressBook` | `Address` | Endereço de entrega configurado para a assinatura. `null` se não houver um definido. |\n| `nodes[].totalAmount` | `Money!` | Estimativa do valor do próximo ciclo (`amount` decimal, `currency`, `displayAmount` já formatado), calculada a partir dos preços de catálogo dos itens. É aproximado — pode incluir itens que serão pulados ou que estão fora de estoque. Para o valor efetivamente cobrado, use o `totalAmount` do ciclo em `shopRecurringOrderCycles` (ou `cyclesInformation.currentCycle.totalAmount`). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente, inválido ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- **Filtro por status é uma lista (\"ou\"), não um valor único.** Envie `filters.status: [ACTIVE, PAUSED]` para trazer assinaturas em qualquer um desses status.\n- **`filters.createdAt.gte`/`lte` são independentes e combináveis** — envie só um dos dois para um filtro \"a partir de\" ou \"até\", ou ambos para um intervalo fechado.\n- **Sem `filters`, a chamada retorna todas as assinaturas da loja**, independente de status.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrdersSortByField` só expõe esse valor; o argumento existe para compatibilidade futura.\n- `cyclesInformation.currentCycle` é apenas um resumo do ciclo mais recente/atual; para navegar por todos os ciclos (incluindo os concluídos), use `shopRecurringOrderCycles` com o `_id` desta assinatura."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shopRecurringOrders\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"customerAccountId\": \"Example_String\",\n \"unboxPayCustomerId\": \"Example_String\",\n \"referenceId\": \"Example_String\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"a10f9325-4da8-419a-88cd-3a06abbb4ccf","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrders($filters: ShopRecurringOrdersFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrdersSortByField) {\n shopRecurringOrders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n cycleIndex\n items {\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n skipped\n status\n quantity\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n }\n error {\n createdAt\n createdBy\n triggeredBy\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n metaDescription\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n productId\n type\n productType\n recurrenceAllowed\n sku\n slug\n supportedFulfillmentTypes\n title\n updatedAt\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n isBackorder\n isLowQuantity\n isSoldOut\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n displayAmount\n }\n cyclePrice {\n amount\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"status\": [\n \"ACTIVE\"\n ],\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrders\n\n**Propósito:** Lista as assinaturas (recurring orders) da loja autenticada, com filtros por status e por período de criação.\n**Quando usar:** Para acompanhar a carteira de assinaturas — ativas, pausadas, canceladas ou em erro. É o ponto de entrada do domínio: a partir do `_id` retornado aqui você consulta o histórico de ciclos com `shopRecurringOrderCycles`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não há argumento de loja nesta query.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | -------------------------------- | ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `filters` | `ShopRecurringOrdersFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todas as assinaturas da loja. |\n| `filters.status` | `[RecurringOrderStatusEnum]` | Não | — | Filtra por uma lista de status (`ACTIVE`, `CANCELED`, `PAUSED`, `ERROR`) — combina com \"ou\": qualquer assinatura cujo status esteja na lista é retornada. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por período de criação: `{ gte: AWSDateTime, lte: AWSDateTime }`, ambos opcionais e combináveis. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrdersSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderConnection!` — conexão Relay (ver paginação no folder). Cada `node` é uma `RecurringOrder`:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `nodes[]._id` | `ID!` | Identificador da assinatura. Use este valor no filtro `recurringOrderId` de `shopRecurringOrderCycles`. |\n| `nodes[].referenceId` | `String!` | Identificador amigável da assinatura. |\n| `nodes[].customerAccountId` | `String!` | Conta do cliente dono da assinatura. |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização. |\n| `nodes[].status` | `RecurringOrderStatus!` | Status da assinatura. `value` (`ACTIVE`/`CANCELED`/`PAUSED`/`ERROR`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].unboxPayCustomerId` | `String!` | Identificador do cliente no Unbox Pay, usado para vincular a cobrança recorrente. |\n| `nodes[].frequency` | `RecurringOrderFrequency!` | Frequência de recorrência: `_id`, `title` (rótulo), `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval` (multiplicador da periodicidade). |\n| `nodes[].pricingPolicy` | `RecurringOrderPricingPolicy!` | Política de preço aplicada aos ciclos: `type` (`PERCENTAGE_OFF`/`AMOUNT_OFF`/`NONE`) e `value`. |\n| `nodes[].cyclesInformation.cycleCount` | `Int!` | Total de ciclos já gerados para esta assinatura. |\n| `nodes[].cyclesInformation.skipNextCycle` | `Boolean!` | Se `true`, o próximo ciclo será pulado automaticamente. |\n| `nodes[].cyclesInformation.lastCycleDate` | `AWSDateTime` | Data do último ciclo gerado. `null` se nenhum ciclo foi gerado ainda. |\n| `nodes[].cyclesInformation.nextCycleDate` | `AWSDateTime` | Data prevista do próximo ciclo. |\n| `nodes[].cyclesInformation.currentCycle` | `RecurringOrderCycle` | Resumo do ciclo em andamento/mais recente. Para o histórico completo, use `shopRecurringOrderCycles`. |\n| `nodes[].items[]` | `[RecurringOrderItem]!` | Itens que compõem cada novo ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `quantity`, `price`, `skipNextCycle` e `catalogProduct` (dados do catálogo). |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado à assinatura (`discountId`, `code`). `null` se nenhum cupom foi usado. |\n| `nodes[].unboxPayCustomerCreditCard` | `RecurringOrderCreditCard!` | Cartão usado para cobrança: `last4Digits` (sempre presente), `first4Digits`/`first6Digits` (nem sempre presentes), `expirationMonth`, `expirationYear`, `holderName`. Nunca traz o número completo do cartão. |\n| `nodes[].shippingAddressBook` | `Address` | Endereço de entrega configurado para a assinatura. `null` se não houver um definido. |\n| `nodes[].totalAmount` | `Money!` | Estimativa do valor do próximo ciclo (`amount` decimal, `currency`, `displayAmount` já formatado), calculada a partir dos preços de catálogo dos itens. É aproximado — pode incluir itens que serão pulados ou que estão fora de estoque. Para o valor efetivamente cobrado, use o `totalAmount` do ciclo em `shopRecurringOrderCycles` (ou `cyclesInformation.currentCycle.totalAmount`). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente, inválido ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- **Filtro por status é uma lista (\"ou\"), não um valor único.** Envie `filters.status: [ACTIVE, PAUSED]` para trazer assinaturas em qualquer um desses status.\n- **`filters.createdAt.gte`/`lte` são independentes e combináveis** — envie só um dos dois para um filtro \"a partir de\" ou \"até\", ou ambos para um intervalo fechado.\n- **Sem `filters`, a chamada retorna todas as assinaturas da loja**, independente de status.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrdersSortByField` só expõe esse valor; o argumento existe para compatibilidade futura.\n- `cyclesInformation.currentCycle` é apenas um resumo do ciclo mais recente/atual; para navegar por todos os ciclos (incluindo os concluídos), use `shopRecurringOrderCycles` com o `_id` desta assinatura."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"9fc1f114-e5a3-49c6-8674-448c8bdf1ae4","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrders($filters: ShopRecurringOrdersFilterInput, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrdersSortByField) {\n shopRecurringOrders(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n cycleIndex\n items {\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n skipped\n status\n quantity\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n }\n error {\n createdAt\n createdBy\n triggeredBy\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n customerAccountId\n discount {\n discountId\n code\n }\n unboxPayCustomerId\n referenceId\n frequency {\n _id\n title\n periodicity\n interval\n }\n pricingPolicy {\n type\n value\n }\n cyclesInformation {\n cycleCount\n skipNextCycle\n lastCycleDate\n nextCycleDate\n currentCycle {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n metaDescription\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n productId\n type\n productType\n recurrenceAllowed\n sku\n slug\n supportedFulfillmentTypes\n title\n updatedAt\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n isBackorder\n isLowQuantity\n isSoldOut\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n displayAmount\n }\n cyclePrice {\n amount\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n price {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n quantity\n skipNextCycle\n }\n unboxPayCustomerCreditCard {\n first4Digits\n first6Digits\n last4Digits\n expirationMonth\n expirationYear\n holderName\n }\n shippingAddressBook {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"status\": [\n \"ACTIVE\"\n ],\n \"createdAt\": {\n \"gte\": \"2025-01-15T10:00:00Z\",\n \"lte\": \"2025-01-15T10:00:00Z\"\n }\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrders\n\n**Propósito:** Lista as assinaturas (recurring orders) da loja autenticada, com filtros por status e por período de criação.\n**Quando usar:** Para acompanhar a carteira de assinaturas — ativas, pausadas, canceladas ou em erro. É o ponto de entrada do domínio: a partir do `_id` retornado aqui você consulta o histórico de ciclos com `shopRecurringOrderCycles`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — não há argumento de loja nesta query.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------- | -------------------------------- | ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `filters` | `ShopRecurringOrdersFilterInput` | Não | `null` | Filtros da listagem. Omitido, retorna todas as assinaturas da loja. |\n| `filters.status` | `[RecurringOrderStatusEnum]` | Não | — | Filtra por uma lista de status (`ACTIVE`, `CANCELED`, `PAUSED`, `ERROR`) — combina com \"ou\": qualquer assinatura cujo status esteja na lista é retornada. |\n| `filters.createdAt` | `DateFilterInput` | Não | — | Filtra por período de criação: `{ gte: AWSDateTime, lte: AWSDateTime }`, ambos opcionais e combináveis. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrdersSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderConnection!` — conexão Relay (ver paginação no folder). Cada `node` é uma `RecurringOrder`:\n\n| Propriedade | Tipo | Descrição |\n| ----------------------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `nodes[]._id` | `ID!` | Identificador da assinatura. Use este valor no filtro `recurringOrderId` de `shopRecurringOrderCycles`. |\n| `nodes[].referenceId` | `String!` | Identificador amigável da assinatura. |\n| `nodes[].customerAccountId` | `String!` | Conta do cliente dono da assinatura. |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização. |\n| `nodes[].status` | `RecurringOrderStatus!` | Status da assinatura. `value` (`ACTIVE`/`CANCELED`/`PAUSED`/`ERROR`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].unboxPayCustomerId` | `String!` | Identificador do cliente no Unbox Pay, usado para vincular a cobrança recorrente. |\n| `nodes[].frequency` | `RecurringOrderFrequency!` | Frequência de recorrência: `_id`, `title` (rótulo), `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval` (multiplicador da periodicidade). |\n| `nodes[].pricingPolicy` | `RecurringOrderPricingPolicy!` | Política de preço aplicada aos ciclos: `type` (`PERCENTAGE_OFF`/`AMOUNT_OFF`/`NONE`) e `value`. |\n| `nodes[].cyclesInformation.cycleCount` | `Int!` | Total de ciclos já gerados para esta assinatura. |\n| `nodes[].cyclesInformation.skipNextCycle` | `Boolean!` | Se `true`, o próximo ciclo será pulado automaticamente. |\n| `nodes[].cyclesInformation.lastCycleDate` | `AWSDateTime` | Data do último ciclo gerado. `null` se nenhum ciclo foi gerado ainda. |\n| `nodes[].cyclesInformation.nextCycleDate` | `AWSDateTime` | Data prevista do próximo ciclo. |\n| `nodes[].cyclesInformation.currentCycle` | `RecurringOrderCycle` | Resumo do ciclo em andamento/mais recente. Para o histórico completo, use `shopRecurringOrderCycles`. |\n| `nodes[].items[]` | `[RecurringOrderItem]!` | Itens que compõem cada novo ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `quantity`, `price`, `skipNextCycle` e `catalogProduct` (dados do catálogo). |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado à assinatura (`discountId`, `code`). `null` se nenhum cupom foi usado. |\n| `nodes[].unboxPayCustomerCreditCard` | `RecurringOrderCreditCard!` | Cartão usado para cobrança: `last4Digits` (sempre presente), `first4Digits`/`first6Digits` (nem sempre presentes), `expirationMonth`, `expirationYear`, `holderName`. Nunca traz o número completo do cartão. |\n| `nodes[].shippingAddressBook` | `Address` | Endereço de entrega configurado para a assinatura. `null` se não houver um definido. |\n| `nodes[].totalAmount` | `Money!` | Estimativa do valor do próximo ciclo (`amount` decimal, `currency`, `displayAmount` já formatado), calculada a partir dos preços de catálogo dos itens. É aproximado — pode incluir itens que serão pulados ou que estão fora de estoque. Para o valor efetivamente cobrado, use o `totalAmount` do ciclo em `shopRecurringOrderCycles` (ou `cyclesInformation.currentCycle.totalAmount`). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\nNenhum código de erro de negócio específico conhecido para esta operação. Falhas de autenticação (`access_token` ausente, inválido ou expirado) seguem o padrão geral descrito na Overview.\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- **Filtro por status é uma lista (\"ou\"), não um valor único.** Envie `filters.status: [ACTIVE, PAUSED]` para trazer assinaturas em qualquer um desses status.\n- **`filters.createdAt.gte`/`lte` são independentes e combináveis** — envie só um dos dois para um filtro \"a partir de\" ou \"até\", ou ambos para um intervalo fechado.\n- **Sem `filters`, a chamada retorna todas as assinaturas da loja**, independente de status.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrdersSortByField` só expõe esse valor; o argumento existe para compatibilidade futura.\n- `cyclesInformation.currentCycle` é apenas um resumo do ciclo mais recente/atual; para navegar por todos os ciclos (incluindo os concluídos), use `shopRecurringOrderCycles` com o `_id` desta assinatura."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"a3712094-3b90-5319-bd38-2ac41a72815f"},{"name":"[Query] shopRecurringOrderCycles","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns shopRecurringOrderCycles data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"shopRecurringOrderCycles\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"shopRecurringOrderCycles returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.shopRecurringOrderCycles;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"0278aab7-40d4-581e-b3d7-ef1cfa2769dd","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrderCycles($filters: RecurringOrderCyclesFilterInput!, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrderCyclesSortByField) {\n shopRecurringOrderCycles(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"recurringOrderId\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"shopRecurringOrderCycles
\nPropósito: Lista o histórico de ciclos (execuções periódicas) de uma assinatura (recurring order) específica.\nQuando usar: Depois de localizar uma assinatura com shopRecurringOrders (ou já conhecendo seu _id), use esta query para inspecionar o que foi cobrado em cada ciclo, quais falharam e por quê, e o pedido (order) gerado por cada ciclo bem-sucedido.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada. O filtro exige o _id da assinatura (recurringOrderId); a Unbox confirma que essa assinatura pertence à loja autenticada antes de retornar qualquer ciclo — caso contrário, a operação falha (ver Erros).
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilters | \nRecurringOrderCyclesFilterInput! | \nSim | \n— | \nFiltro da listagem. Obrigatório — não é possível listar ciclos sem informar a assinatura. | \n
\n\nfilters.recurringOrderId | \nString! | \nSim | \n— | \n_id da assinatura (retornado por shopRecurringOrders) cujos ciclos serão listados. | \n
\n\nafter | \nString | \nNão | \nnull | \nCursor Relay: retorna resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \nnull | \nCursor Relay: retorna resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Usado com after ou offset. | \n
\n\nlast | \nInt | \nNão | \n— | \nQuantidade máxima de resultados. Usado com before. | \n
\n\noffset | \nInt | \nNão | \n— | \nRetorna resultados a partir do N-ésimo item. Alternativa a after baseada em posição. | \n
\n\nsortOrder | \nSortOrder | \nNão | \ndesc | \nOrdem de classificação: asc ou desc. | \n
\n\nsortBy | \nRecurringOrderCyclesSortByField | \nNão | \ncreatedAt | \nCampo de ordenação. Único valor disponível hoje: createdAt. | \n
\n\n
\n
Retorno
\nRecurringOrderCycleConnection! — conexão Relay (ver paginação no folder). Cada node é um RecurringOrderCycle:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes[]._id | \nID! | \nIdentificador do ciclo. | \n
\n\nnodes[].recurringOrderId | \nString! | \n_id da assinatura que originou este ciclo (mesmo valor enviado no filtro). | \n
\n\nnodes[].cycleIndex | \nInt! | \nPosição deste ciclo na sequência da assinatura (1-based: o primeiro ciclo é 1). | \n
\n\nnodes[].createdAt / updatedAt | \nAWSDateTime! | \nDatas de criação e última atualização do ciclo. | \n
\n\nnodes[].completedAt | \nAWSDateTime | \nData em que o ciclo foi concluído. null enquanto o ciclo ainda está pendente. | \n
\n\nnodes[].status | \nRecurringOrderCycleStatus! | \nStatus do ciclo. value (PENDING, SUCCESS, ERROR ou REVIEW_REQUIRED) traz o status atual; createdAt/createdBy/triggeredBy descrevem quando e por quem essa transição ocorreu. | \n
\n\nnodes[].status.history[] | \nRecurringOrderCycleStatusHistory | \nHistórico de mudanças de status, cada item com value, createdAt, triggeredBy. | \n
\n\nnodes[].skipped | \nBoolean! | \nSe true, este ciclo foi pulado (não gerou cobrança nem pedido). | \n
\n\nnodes[].error | \nRecurringOrderErrors | \nPreenchido apenas quando status é ERROR ou REVIEW_REQUIRED. error.value.type traz o motivo (RecurringOrderErrorTypeEnum, ver folder) e error.value.message uma descrição legível; error.history[] guarda erros de tentativas anteriores. | \n
\n\nnodes[].attemptingRetry | \nBoolean! | \nSe true, uma nova tentativa automática está em andamento para este ciclo. | \n
\n\nnodes[].retryAttempt | \nRetryAttempt | \nMetadados da retentativa: nextRetryDate (próxima tentativa agendada) e currentRetryAttempt (contagem de tentativas já feitas). | \n
\n\nnodes[].manuallyRetried | \nBoolean! | \nSe true, este ciclo foi retentado manualmente (fora do fluxo automático). | \n
\n\nnodes[].manuallyRetriedByAccountId | \nString | \nConta responsável pela retentativa manual, quando aplicável. | \n
\n\nnodes[].order | \nOrder | \nPedido gerado a partir deste ciclo. null até o ciclo ser processado com sucesso. | \n
\n\nnodes[].items[] | \n[RecurringOrderCycleItem]! | \nItens deste ciclo: productId/variantId/productKitId e os códigos de ERP correspondentes (productERPCode, variantERPCode), productKitItemsConfigurations (configuração de cada componente, para itens do tipo kit), catalogProduct (dados do produto no catálogo), quantity, status (CycleItemStatusEnum — ver folder), skipped, originalPrice e cyclePrice (pode diferir do original quando há desconto aplicado ao ciclo). | \n
\n\nnodes[].pricingPolicy / frequency | \nRecurringOrderPricingPolicy! / RecurringOrderFrequency! | \nPolítica de preço e frequência vigentes neste ciclo — podem ter sido sobrescritas em relação à assinatura original, sem alterá-la. frequency inclui _id, title, periodicity (DAY/WEEK/MONTH) e interval. | \n
\n\nnodes[].discount | \nRecurringOrderDiscountData | \nCupom de desconto aplicado a este ciclo especificamente. null se nenhum foi usado. | \n
\n\nnodes[].totalAmount | \nMoney! | \nValor total cobrado neste ciclo: amount (decimal), currency, displayAmount (já formatado). | \n
\n\npageInfo / totalCount | \nPageInfo! / Int! | \nMetadados de paginação Relay — ver folder. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nRECURRING_ORDER_NOT_FOUND_ERROR | \nfilters.recurringOrderId não corresponde a nenhuma assinatura da loja autenticada (não existe ou pertence a outra loja). | \nConfirme o _id usando o resultado de shopRecurringOrders. | \n
\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo aqui. Como filters é obrigatório, omiti-lo (ou omitir filters.recurringOrderId) resulta em um erro de validação do GraphQL com mensagem descritiva — que nem sempre carrega um extensions.code estável. Verifique sempre message.
\n
\nNotas
\n\nfilters.recurringOrderId é obrigatório — não existe uma forma de listar ciclos de todas as assinaturas de uma vez; cada chamada é sempre por uma assinatura.- Não há filtro por status de ciclo. O único filtro disponível é
recurringOrderId. Para cenários como \"listar apenas os ciclos em erro de uma assinatura\", pagine o histórico completo (first/after) e filtre por nodes[].status.value no seu lado. \norder só aparece após o ciclo ser concluído com sucesso. Ciclos pendentes ou em erro trazem order: null.error só é preenchido em ciclos com problema. Para ciclos PENDING/SUCCESS, o campo vem null; use error.value.type para tratar programaticamente e error.value.message só para exibição/log.pricingPolicy, frequency, items e discount refletem o que valeu para aquele ciclo, não necessariamente a configuração atual da assinatura — um ciclo pode ter sido ajustado pontualmente sem alterar a assinatura original.- Ordenação hoje é fixa por
createdAt — o enum RecurringOrderCyclesSortByField só expõe esse valor. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6cb6c11-972d-43ae-9552-08397741b945","name":"200 - shopRecurringOrderCycles","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrderCycles($filters: RecurringOrderCyclesFilterInput!, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrderCyclesSortByField) {\n shopRecurringOrderCycles(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"recurringOrderId\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrderCycles\n\n**Propósito:** Lista o histórico de ciclos (execuções periódicas) de uma assinatura (recurring order) específica.\n**Quando usar:** Depois de localizar uma assinatura com `shopRecurringOrders` (ou já conhecendo seu `_id`), use esta query para inspecionar o que foi cobrado em cada ciclo, quais falharam e por quê, e o pedido (`order`) gerado por cada ciclo bem-sucedido.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada. O filtro exige o `_id` da assinatura (`recurringOrderId`); a Unbox confirma que essa assinatura pertence à loja autenticada antes de retornar qualquer ciclo — caso contrário, a operação falha (ver Erros).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------- | ---------------------------------- | ----------- | ----------- | ----------------------------------------------------------------------------------------- |\n| `filters` | `RecurringOrderCyclesFilterInput!` | Sim | — | Filtro da listagem. Obrigatório — não é possível listar ciclos sem informar a assinatura. |\n| `filters.recurringOrderId` | `String!` | Sim | — | `_id` da assinatura (retornado por `shopRecurringOrders`) cujos ciclos serão listados. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrderCyclesSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderCycleConnection!` — conexão Relay (ver paginação no folder). Cada `node` é um `RecurringOrderCycle`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `nodes[]._id` | `ID!` | Identificador do ciclo. |\n| `nodes[].recurringOrderId` | `String!` | `_id` da assinatura que originou este ciclo (mesmo valor enviado no filtro). |\n| `nodes[].cycleIndex` | `Int!` | Posição deste ciclo na sequência da assinatura (1-based: o primeiro ciclo é `1`). |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização do ciclo. |\n| `nodes[].completedAt` | `AWSDateTime` | Data em que o ciclo foi concluído. `null` enquanto o ciclo ainda está pendente. |\n| `nodes[].status` | `RecurringOrderCycleStatus!` | Status do ciclo. `value` (`PENDING`, `SUCCESS`, `ERROR` ou `REVIEW_REQUIRED`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderCycleStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].skipped` | `Boolean!` | Se `true`, este ciclo foi pulado (não gerou cobrança nem pedido). |\n| `nodes[].error` | `RecurringOrderErrors` | Preenchido apenas quando `status` é `ERROR` ou `REVIEW_REQUIRED`. `error.value.type` traz o motivo (`RecurringOrderErrorTypeEnum`, ver folder) e `error.value.message` uma descrição legível; `error.history[]` guarda erros de tentativas anteriores. |\n| `nodes[].attemptingRetry` | `Boolean!` | Se `true`, uma nova tentativa automática está em andamento para este ciclo. |\n| `nodes[].retryAttempt` | `RetryAttempt` | Metadados da retentativa: `nextRetryDate` (próxima tentativa agendada) e `currentRetryAttempt` (contagem de tentativas já feitas). |\n| `nodes[].manuallyRetried` | `Boolean!` | Se `true`, este ciclo foi retentado manualmente (fora do fluxo automático). |\n| `nodes[].manuallyRetriedByAccountId` | `String` | Conta responsável pela retentativa manual, quando aplicável. |\n| `nodes[].order` | `Order` | Pedido gerado a partir deste ciclo. `null` até o ciclo ser processado com sucesso. |\n| `nodes[].items[]` | `[RecurringOrderCycleItem]!` | Itens deste ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `catalogProduct` (dados do produto no catálogo), `quantity`, `status` (`CycleItemStatusEnum` — ver folder), `skipped`, `originalPrice` e `cyclePrice` (pode diferir do original quando há desconto aplicado ao ciclo). |\n| `nodes[].pricingPolicy` / `frequency` | `RecurringOrderPricingPolicy!` / `RecurringOrderFrequency!` | Política de preço e frequência vigentes **neste ciclo** — podem ter sido sobrescritas em relação à assinatura original, sem alterá-la. `frequency` inclui `_id`, `title`, `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval`. |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado a este ciclo especificamente. `null` se nenhum foi usado. |\n| `nodes[].totalAmount` | `Money!` | Valor total cobrado neste ciclo: `amount` (decimal), `currency`, `displayAmount` (já formatado). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |\n| `RECURRING_ORDER_NOT_FOUND_ERROR` | `filters.recurringOrderId` não corresponde a nenhuma assinatura da loja autenticada (não existe ou pertence a outra loja). | Confirme o `_id` usando o resultado de `shopRecurringOrders`. |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. Como `filters` é obrigatório, omiti-lo (ou omitir `filters.recurringOrderId`) resulta em um erro de validação do GraphQL com mensagem descritiva — que nem sempre carrega um `extensions.code` estável. Verifique sempre `message`.\n\n### Notas\n\n- **`filters.recurringOrderId` é obrigatório** — não existe uma forma de listar ciclos de todas as assinaturas de uma vez; cada chamada é sempre por uma assinatura.\n- **Não há filtro por status de ciclo.** O único filtro disponível é `recurringOrderId`. Para cenários como \"listar apenas os ciclos em erro de uma assinatura\", pagine o histórico completo (`first`/`after`) e filtre por `nodes[].status.value` no seu lado.\n- **`order` só aparece após o ciclo ser concluído com sucesso.** Ciclos pendentes ou em erro trazem `order: null`.\n- **`error` só é preenchido em ciclos com problema.** Para ciclos `PENDING`/`SUCCESS`, o campo vem `null`; use `error.value.type` para tratar programaticamente e `error.value.message` só para exibição/log.\n- **`pricingPolicy`, `frequency`, `items` e `discount` refletem o que valeu _para aquele ciclo_, não necessariamente a configuração atual da assinatura** — um ciclo pode ter sido ajustado pontualmente sem alterar a assinatura original.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrderCyclesSortByField` só expõe esse valor."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shopRecurringOrderCycles\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"completedAt\": \"2025-01-15T10:00:00Z\",\n \"recurringOrderId\": \"Example_String\",\n \"cycleIndex\": 10,\n \"skipped\": true,\n \"attemptingRetry\": true,\n \"manuallyRetried\": true,\n \"manuallyRetriedByAccountId\": \"Example_String\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"6d7996ea-c1f1-4144-9af3-f58ade781045","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrderCycles($filters: RecurringOrderCyclesFilterInput!, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrderCyclesSortByField) {\n shopRecurringOrderCycles(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"recurringOrderId\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrderCycles\n\n**Propósito:** Lista o histórico de ciclos (execuções periódicas) de uma assinatura (recurring order) específica.\n**Quando usar:** Depois de localizar uma assinatura com `shopRecurringOrders` (ou já conhecendo seu `_id`), use esta query para inspecionar o que foi cobrado em cada ciclo, quais falharam e por quê, e o pedido (`order`) gerado por cada ciclo bem-sucedido.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada. O filtro exige o `_id` da assinatura (`recurringOrderId`); a Unbox confirma que essa assinatura pertence à loja autenticada antes de retornar qualquer ciclo — caso contrário, a operação falha (ver Erros).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------- | ---------------------------------- | ----------- | ----------- | ----------------------------------------------------------------------------------------- |\n| `filters` | `RecurringOrderCyclesFilterInput!` | Sim | — | Filtro da listagem. Obrigatório — não é possível listar ciclos sem informar a assinatura. |\n| `filters.recurringOrderId` | `String!` | Sim | — | `_id` da assinatura (retornado por `shopRecurringOrders`) cujos ciclos serão listados. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrderCyclesSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderCycleConnection!` — conexão Relay (ver paginação no folder). Cada `node` é um `RecurringOrderCycle`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `nodes[]._id` | `ID!` | Identificador do ciclo. |\n| `nodes[].recurringOrderId` | `String!` | `_id` da assinatura que originou este ciclo (mesmo valor enviado no filtro). |\n| `nodes[].cycleIndex` | `Int!` | Posição deste ciclo na sequência da assinatura (1-based: o primeiro ciclo é `1`). |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização do ciclo. |\n| `nodes[].completedAt` | `AWSDateTime` | Data em que o ciclo foi concluído. `null` enquanto o ciclo ainda está pendente. |\n| `nodes[].status` | `RecurringOrderCycleStatus!` | Status do ciclo. `value` (`PENDING`, `SUCCESS`, `ERROR` ou `REVIEW_REQUIRED`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderCycleStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].skipped` | `Boolean!` | Se `true`, este ciclo foi pulado (não gerou cobrança nem pedido). |\n| `nodes[].error` | `RecurringOrderErrors` | Preenchido apenas quando `status` é `ERROR` ou `REVIEW_REQUIRED`. `error.value.type` traz o motivo (`RecurringOrderErrorTypeEnum`, ver folder) e `error.value.message` uma descrição legível; `error.history[]` guarda erros de tentativas anteriores. |\n| `nodes[].attemptingRetry` | `Boolean!` | Se `true`, uma nova tentativa automática está em andamento para este ciclo. |\n| `nodes[].retryAttempt` | `RetryAttempt` | Metadados da retentativa: `nextRetryDate` (próxima tentativa agendada) e `currentRetryAttempt` (contagem de tentativas já feitas). |\n| `nodes[].manuallyRetried` | `Boolean!` | Se `true`, este ciclo foi retentado manualmente (fora do fluxo automático). |\n| `nodes[].manuallyRetriedByAccountId` | `String` | Conta responsável pela retentativa manual, quando aplicável. |\n| `nodes[].order` | `Order` | Pedido gerado a partir deste ciclo. `null` até o ciclo ser processado com sucesso. |\n| `nodes[].items[]` | `[RecurringOrderCycleItem]!` | Itens deste ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `catalogProduct` (dados do produto no catálogo), `quantity`, `status` (`CycleItemStatusEnum` — ver folder), `skipped`, `originalPrice` e `cyclePrice` (pode diferir do original quando há desconto aplicado ao ciclo). |\n| `nodes[].pricingPolicy` / `frequency` | `RecurringOrderPricingPolicy!` / `RecurringOrderFrequency!` | Política de preço e frequência vigentes **neste ciclo** — podem ter sido sobrescritas em relação à assinatura original, sem alterá-la. `frequency` inclui `_id`, `title`, `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval`. |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado a este ciclo especificamente. `null` se nenhum foi usado. |\n| `nodes[].totalAmount` | `Money!` | Valor total cobrado neste ciclo: `amount` (decimal), `currency`, `displayAmount` (já formatado). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |\n| `RECURRING_ORDER_NOT_FOUND_ERROR` | `filters.recurringOrderId` não corresponde a nenhuma assinatura da loja autenticada (não existe ou pertence a outra loja). | Confirme o `_id` usando o resultado de `shopRecurringOrders`. |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. Como `filters` é obrigatório, omiti-lo (ou omitir `filters.recurringOrderId`) resulta em um erro de validação do GraphQL com mensagem descritiva — que nem sempre carrega um `extensions.code` estável. Verifique sempre `message`.\n\n### Notas\n\n- **`filters.recurringOrderId` é obrigatório** — não existe uma forma de listar ciclos de todas as assinaturas de uma vez; cada chamada é sempre por uma assinatura.\n- **Não há filtro por status de ciclo.** O único filtro disponível é `recurringOrderId`. Para cenários como \"listar apenas os ciclos em erro de uma assinatura\", pagine o histórico completo (`first`/`after`) e filtre por `nodes[].status.value` no seu lado.\n- **`order` só aparece após o ciclo ser concluído com sucesso.** Ciclos pendentes ou em erro trazem `order: null`.\n- **`error` só é preenchido em ciclos com problema.** Para ciclos `PENDING`/`SUCCESS`, o campo vem `null`; use `error.value.type` para tratar programaticamente e `error.value.message` só para exibição/log.\n- **`pricingPolicy`, `frequency`, `items` e `discount` refletem o que valeu _para aquele ciclo_, não necessariamente a configuração atual da assinatura** — um ciclo pode ter sido ajustado pontualmente sem alterar a assinatura original.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrderCyclesSortByField` só expõe esse valor."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"d7add913-a003-4311-804a-a30bfe1cbaf3","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopRecurringOrderCycles($filters: RecurringOrderCyclesFilterInput!, $after: String, $before: String, $first: Int, $last: Int, $offset: Int, $sortOrder: SortOrder, $sortBy: RecurringOrderCyclesSortByField) {\n shopRecurringOrderCycles(filters: $filters, after: $after, before: $before, first: $first, last: $last, offset: $offset, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n }\n nodes {\n _id\n shopId\n createdAt\n updatedAt\n completedAt\n discount {\n discountId\n code\n }\n recurringOrderId\n order {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n cycleIndex\n items {\n catalogProduct {\n _id\n erpCode\n barcode\n createdAt\n description\n height\n isDeleted\n isVisible\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metaDescription\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n originCountry\n pageTitle\n parcel {\n containers\n distanceUnit\n height\n length\n massUnit\n weight\n width\n }\n primaryImage {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n productId\n type\n productType\n recurrenceAllowed\n shop {\n shopSales {\n _id\n code\n description\n discountMethod\n label\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n minDaysIntervalBetweenCycles\n keepOrderPricingPolicy\n termsAndConditions\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n slug\n socialMetadata {\n message\n service\n }\n supportedFulfillmentTypes\n title\n updatedAt\n variants {\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n quantity\n primaryImage {\n _id\n priority\n productId\n variantId\n }\n shop {\n _id\n description\n isCompany\n keywords\n name\n slug\n storeTemplateUrl\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n sku\n title\n updatedAt\n variantId\n productId\n productERPCode\n videoUrls\n weight\n width\n canBackorder\n inventoryAvailableToSell\n inventoryInStock\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n pricingOnRecurrence {\n displayPrice\n maxPrice\n minPrice\n price\n }\n isTaxable\n taxCode\n taxDescription\n imageUrls\n }\n vendor\n sortIndex\n videoUrls\n weight\n width\n additionalInformation\n measurementsInformation\n group {\n label\n linkedProducts {\n erpCode\n productId\n title\n label\n slug\n imageUrls\n }\n }\n requiredPicksPerGroup\n unitPriceLabel\n titleLabel\n highlightLabel\n kitGroupDescription\n unitPriceFactor\n relatedInfo {\n title\n highlightLabel\n showUnitPrice\n }\n isBackorder\n isLowQuantity\n isSoldOut\n pricing {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingOnRecurrence {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n pricingPerUnit {\n minCompareAtPrice {\n amount\n displayAmount\n }\n maxCompareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n compareAtPrice\n displayCompareAtPrice\n }\n tagIds\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n isDeleted\n isTopLevel\n isVisible\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n imageUrls\n }\n productERPCode\n productId\n variantERPCode\n variantId\n productKitId\n productKitItemsConfigurations {\n inventoryAvailableToSell\n isBackorder\n isLowQuantity\n isSoldOut\n quantity\n variantTitle\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n skipped\n status\n quantity\n originalPrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n cyclePrice {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pricingPolicy {\n type\n value\n }\n frequency {\n _id\n title\n periodicity\n interval\n }\n skipped\n status {\n value\n createdAt\n createdBy\n triggeredBy\n history {\n value\n createdAt\n createdBy\n triggeredBy\n }\n }\n error {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n history {\n value {\n type\n message\n }\n createdAt\n createdBy\n triggeredBy\n }\n }\n attemptingRetry\n retryAttempt {\n nextRetryDate\n currentRetryAttempt\n }\n manuallyRetried\n manuallyRetriedByAccountId\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filters\": {\n \"recurringOrderId\": \"Example_String\"\n },\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"offset\": 10,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"createdAt\"\n}"}},"url":"{{base_url}}","description":"## shopRecurringOrderCycles\n\n**Propósito:** Lista o histórico de ciclos (execuções periódicas) de uma assinatura (recurring order) específica.\n**Quando usar:** Depois de localizar uma assinatura com `shopRecurringOrders` (ou já conhecendo seu `_id`), use esta query para inspecionar o que foi cobrado em cada ciclo, quais falharam e por quê, e o pedido (`order`) gerado por cada ciclo bem-sucedido.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada. O filtro exige o `_id` da assinatura (`recurringOrderId`); a Unbox confirma que essa assinatura pertence à loja autenticada antes de retornar qualquer ciclo — caso contrário, a operação falha (ver Erros).\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| -------------------------- | ---------------------------------- | ----------- | ----------- | ----------------------------------------------------------------------------------------- |\n| `filters` | `RecurringOrderCyclesFilterInput!` | Sim | — | Filtro da listagem. Obrigatório — não é possível listar ciclos sem informar a assinatura. |\n| `filters.recurringOrderId` | `String!` | Sim | — | `_id` da assinatura (retornado por `shopRecurringOrders`) cujos ciclos serão listados. |\n| `after` | `String` | Não | `null` | Cursor Relay: retorna resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | `null` | Cursor Relay: retorna resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `after` ou `offset`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados. Usado com `before`. |\n| `offset` | `Int` | Não | — | Retorna resultados a partir do N-ésimo item. Alternativa a `after` baseada em posição. |\n| `sortOrder` | `SortOrder` | Não | `desc` | Ordem de classificação: `asc` ou `desc`. |\n| `sortBy` | `RecurringOrderCyclesSortByField` | Não | `createdAt` | Campo de ordenação. Único valor disponível hoje: `createdAt`. |\n\n### Retorno\n\n`RecurringOrderCycleConnection!` — conexão Relay (ver paginação no folder). Cada `node` é um `RecurringOrderCycle`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `nodes[]._id` | `ID!` | Identificador do ciclo. |\n| `nodes[].recurringOrderId` | `String!` | `_id` da assinatura que originou este ciclo (mesmo valor enviado no filtro). |\n| `nodes[].cycleIndex` | `Int!` | Posição deste ciclo na sequência da assinatura (1-based: o primeiro ciclo é `1`). |\n| `nodes[].createdAt` / `updatedAt` | `AWSDateTime!` | Datas de criação e última atualização do ciclo. |\n| `nodes[].completedAt` | `AWSDateTime` | Data em que o ciclo foi concluído. `null` enquanto o ciclo ainda está pendente. |\n| `nodes[].status` | `RecurringOrderCycleStatus!` | Status do ciclo. `value` (`PENDING`, `SUCCESS`, `ERROR` ou `REVIEW_REQUIRED`) traz o status atual; `createdAt`/`createdBy`/`triggeredBy` descrevem quando e por quem essa transição ocorreu. |\n| `nodes[].status.history[]` | `RecurringOrderCycleStatusHistory` | Histórico de mudanças de status, cada item com `value`, `createdAt`, `triggeredBy`. |\n| `nodes[].skipped` | `Boolean!` | Se `true`, este ciclo foi pulado (não gerou cobrança nem pedido). |\n| `nodes[].error` | `RecurringOrderErrors` | Preenchido apenas quando `status` é `ERROR` ou `REVIEW_REQUIRED`. `error.value.type` traz o motivo (`RecurringOrderErrorTypeEnum`, ver folder) e `error.value.message` uma descrição legível; `error.history[]` guarda erros de tentativas anteriores. |\n| `nodes[].attemptingRetry` | `Boolean!` | Se `true`, uma nova tentativa automática está em andamento para este ciclo. |\n| `nodes[].retryAttempt` | `RetryAttempt` | Metadados da retentativa: `nextRetryDate` (próxima tentativa agendada) e `currentRetryAttempt` (contagem de tentativas já feitas). |\n| `nodes[].manuallyRetried` | `Boolean!` | Se `true`, este ciclo foi retentado manualmente (fora do fluxo automático). |\n| `nodes[].manuallyRetriedByAccountId` | `String` | Conta responsável pela retentativa manual, quando aplicável. |\n| `nodes[].order` | `Order` | Pedido gerado a partir deste ciclo. `null` até o ciclo ser processado com sucesso. |\n| `nodes[].items[]` | `[RecurringOrderCycleItem]!` | Itens deste ciclo: `productId`/`variantId`/`productKitId` e os códigos de ERP correspondentes (`productERPCode`, `variantERPCode`), `productKitItemsConfigurations` (configuração de cada componente, para itens do tipo kit), `catalogProduct` (dados do produto no catálogo), `quantity`, `status` (`CycleItemStatusEnum` — ver folder), `skipped`, `originalPrice` e `cyclePrice` (pode diferir do original quando há desconto aplicado ao ciclo). |\n| `nodes[].pricingPolicy` / `frequency` | `RecurringOrderPricingPolicy!` / `RecurringOrderFrequency!` | Política de preço e frequência vigentes **neste ciclo** — podem ter sido sobrescritas em relação à assinatura original, sem alterá-la. `frequency` inclui `_id`, `title`, `periodicity` (`DAY`/`WEEK`/`MONTH`) e `interval`. |\n| `nodes[].discount` | `RecurringOrderDiscountData` | Cupom de desconto aplicado a este ciclo especificamente. `null` se nenhum foi usado. |\n| `nodes[].totalAmount` | `Money!` | Valor total cobrado neste ciclo: `amount` (decimal), `currency`, `displayAmount` (já formatado). |\n| `pageInfo` / `totalCount` | `PageInfo!` / `Int!` | Metadados de paginação Relay — ver folder. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |\n| `RECURRING_ORDER_NOT_FOUND_ERROR` | `filters.recurringOrderId` não corresponde a nenhuma assinatura da loja autenticada (não existe ou pertence a outra loja). | Confirme o `_id` usando o resultado de `shopRecurringOrders`. |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui. Como `filters` é obrigatório, omiti-lo (ou omitir `filters.recurringOrderId`) resulta em um erro de validação do GraphQL com mensagem descritiva — que nem sempre carrega um `extensions.code` estável. Verifique sempre `message`.\n\n### Notas\n\n- **`filters.recurringOrderId` é obrigatório** — não existe uma forma de listar ciclos de todas as assinaturas de uma vez; cada chamada é sempre por uma assinatura.\n- **Não há filtro por status de ciclo.** O único filtro disponível é `recurringOrderId`. Para cenários como \"listar apenas os ciclos em erro de uma assinatura\", pagine o histórico completo (`first`/`after`) e filtre por `nodes[].status.value` no seu lado.\n- **`order` só aparece após o ciclo ser concluído com sucesso.** Ciclos pendentes ou em erro trazem `order: null`.\n- **`error` só é preenchido em ciclos com problema.** Para ciclos `PENDING`/`SUCCESS`, o campo vem `null`; use `error.value.type` para tratar programaticamente e `error.value.message` só para exibição/log.\n- **`pricingPolicy`, `frequency`, `items` e `discount` refletem o que valeu _para aquele ciclo_, não necessariamente a configuração atual da assinatura** — um ciclo pode ter sido ajustado pontualmente sem alterar a assinatura original.\n- **Ordenação hoje é fixa por `createdAt`** — o enum `RecurringOrderCyclesSortByField` só expõe esse valor."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"0278aab7-40d4-581e-b3d7-ef1cfa2769dd"}],"id":"9876d450-88dd-4318-a8f8-3750122fd540","_postman_id":"9876d450-88dd-4318-a8f8-3750122fd540","description":""}],"id":"65a2ab83-7150-4d0a-81c3-9752e0c94707","description":"Assinaturas Recorrentes
\nConsultas somente-leitura para acompanhar as assinaturas (recurring orders) de clientes na sua loja e o histórico de ciclos gerados por cada uma.
\nConceitos
\n\n- Recurring Order (assinatura): o \"contrato\" de recorrência entre um cliente e a loja. Define os itens comprados, a frequência de recorrência, a política de preço/desconto aplicada e o cartão de crédito usado para cobrança. Permanece ativa até ser pausada, cancelada ou entrar em erro.
\n- Cycle (ciclo): cada execução periódica gerada a partir de uma Recurring Order, no intervalo definido pela sua frequência. Um ciclo herda a configuração da Recurring Order no momento em que é criado, mas pode ser ajustado pontualmente (ex.: itens ou preço só daquele ciclo) sem alterar a assinatura original. Quando processado com sucesso, o ciclo gera um pedido (
order); quando falha, carrega o motivo do erro e pode ser retentado. \n
\nNa prática: shopRecurringOrders lista as assinaturas da loja; shopRecurringOrderCycles detalha o histórico de execuções de uma assinatura específica, identificada pelo seu _id.
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores | \nDescrição | \n
\n\n\n\nRecurringOrderStatusEnum | \nACTIVE, CANCELED, PAUSED, ERROR | \nStatus da assinatura como um todo. | \n
\n\nRecurringOrderCycleStatusEnum | \nPENDING, SUCCESS, ERROR, REVIEW_REQUIRED | \nStatus de um ciclo individual. | \n
\n\nPeriodicityEnum | \nDAY, WEEK, MONTH | \nUnidade de tempo da frequência de recorrência, combinada com um interval numérico (ex.: interval: 2 + periodicity: WEEK = a cada duas semanas). | \n
\n\nPricingTypeEnum | \nPERCENTAGE_OFF, AMOUNT_OFF, NONE | \nTipo de desconto aplicado sobre o preço padrão dos itens em cada ciclo. | \n
\n\nCycleItemStatusEnum | \nAVAILABLE, MISSING, OUT_OF_STOCK, NOT_ALLOWED | \nDisponibilidade de cada item dentro de um ciclo no momento em que ele foi processado. | \n
\n\nRecurringOrderErrorTypeEnum | \nADDRESS_BOOK_ERROR, NO_FULFILLMENT_OPTIONS, PAYMENT_ERROR, ITEM_ERROR, NO_AVAILABLE_ITEMS, CUSTOMER_ACCOUNT_ERROR, UNBOX_PAY_CUSTOMER_ERROR, UNEXPECTED_ERROR, CREATE_CART_ERROR, PLACE_ORDER_ERROR | \nMotivo pelo qual o processamento de um ciclo falhou, exposto no campo error do ciclo. | \n
\n\n
\n
Paginação (Relay)
\nAs duas queries deste grupo retornam uma conexão no padrão Relay: nodes (array com os itens da página atual), edges (cada um com cursor + node), pageInfo (hasNextPage, hasPreviousPage, startCursor, endCursor) e totalCount. Use first/after para paginar para frente e last/before para paginar para trás; offset é uma alternativa a after baseada em posição numérica. sortOrder (asc/desc, padrão desc) e sortBy controlam a ordenação — hoje ambas as queries só oferecem createdAt como campo de ordenação.
\nRegras de negócio
\n\nshopRecurringOrders lista todas as assinaturas da loja; shopRecurringOrderCycles exige uma assinatura específica. O filtro de shopRecurringOrderCycles é obrigatório e recebe o _id da Recurring Order — não existe forma de listar ciclos de todas as assinaturas em uma única chamada.- Fluxo típico: chame
shopRecurringOrders para localizar a assinatura (e obter seu _id), depois shopRecurringOrderCycles para inspecionar o histórico completo de cobranças/execuções dela. \n- A assinatura sempre traz um resumo dos ciclos embutido (
cyclesInformation: contagem, próxima/última data de ciclo e o ciclo atual). Para o histórico completo, item a item, use shopRecurringOrderCycles. \n- Um ciclo só tem
error preenchido quando falha (status ERROR ou REVIEW_REQUIRED); ciclos PENDING/SUCCESS trazem error: null. \n- Ownership: a assinatura consultada em
shopRecurringOrderCycles precisa pertencer à loja autenticada — passar o _id de uma assinatura de outra loja resulta em erro (ver a página da operação). \n
\n","_postman_id":"65a2ab83-7150-4d0a-81c3-9752e0c94707"},{"name":"Settings","item":[{"name":"Query","item":[{"name":"[Query] shopSettings","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns shopSettings data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"shopSettings\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"shopSettings returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.shopSettings;"," "," if (data !== null) {"," if (data.tresCliques !== undefined && data.tresCliques !== null) {"," pm.expect(data.tresCliques).to.be.an(\"object\");"," }"," if (data.showOutOfStockCatalogs !== undefined && data.showOutOfStockCatalogs !== null) {"," pm.expect(typeof data.showOutOfStockCatalogs).to.equal(\"boolean\");"," }"," if (data.loginWithCustomDomain !== undefined && data.loginWithCustomDomain !== null) {"," pm.expect(typeof data.loginWithCustomDomain).to.equal(\"boolean\");"," }"," if (data.discountPerCart !== undefined && data.discountPerCart !== null) {"," pm.expect(typeof data.discountPerCart).to.equal(\"boolean\");"," }"," if (data.intelipostProductsNature !== undefined && data.intelipostProductsNature !== null) {"," pm.expect(typeof data.intelipostProductsNature).to.equal(\"string\");"," }"," if (data.intelipostRecurrentProductCategory !== undefined && data.intelipostRecurrentProductCategory !== null) {"," pm.expect(typeof data.intelipostRecurrentProductCategory).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"canSellVariantWithoutInventory\");"," if (data.canSellVariantWithoutInventory !== undefined && data.canSellVariantWithoutInventory !== null) {"," pm.expect(typeof data.canSellVariantWithoutInventory).to.equal(\"boolean\");"," }"," if (data.saveShippingLabelToStorage !== undefined && data.saveShippingLabelToStorage !== null) {"," pm.expect(typeof data.saveShippingLabelToStorage).to.equal(\"boolean\");"," }"," pm.expect(data).to.have.property(\"shouldNavigationTreeItemsBeAdminOnly\");"," if (data.shouldNavigationTreeItemsBeAdminOnly !== undefined && data.shouldNavigationTreeItemsBeAdminOnly !== null) {"," pm.expect(typeof data.shouldNavigationTreeItemsBeAdminOnly).to.equal(\"boolean\");"," }"," pm.expect(data).to.have.property(\"shouldNavigationTreeItemsBePubliclyVisible\");"," if (data.shouldNavigationTreeItemsBePubliclyVisible !== undefined && data.shouldNavigationTreeItemsBePubliclyVisible !== null) {"," pm.expect(typeof data.shouldNavigationTreeItemsBePubliclyVisible).to.equal(\"boolean\");"," }"," }","});"]}}],"id":"1e5582ff-2d95-52ac-9426-032f8ff5b73d","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopSettings {\n shopSettings {\n tresCliques {\n callbackUrl\n callbackKey\n }\n showOutOfStockCatalogs\n loginWithCustomDomain\n discountPerCart\n intelipostProductsNature\n intelipostRecurrentProductCategory\n canSellVariantWithoutInventory\n saveShippingLabelToStorage\n shouldNavigationTreeItemsBeAdminOnly\n shouldNavigationTreeItemsBePubliclyVisible\n shouldNavigationTreeItemsBeSecondaryNavOnly\n enableFraudPrevention\n generateInvoice\n generateInvoiceOnPaymentApproval\n allowLegalPersonSales\n maxInvoiceRetryAttempts\n invoiceIssueAttemptsDelayInMinutes\n allowAnonymousRecurringOrders\n doNotUse\n isShippingRatesFulfillmentEnabled\n shopTrialPeriod\n createdAt\n updatedAt\n defaultTaxCode\n fallbackTaxServiceName\n primaryTaxServiceName\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"shopSettings
\nPropósito: Retorna as configurações operacionais da sua loja — faturamento/nota fiscal, impostos, estoque, assinaturas, navegação e a integração de callback do External Checkout (tresCliques).\nQuando usar: Consulte antes de operar o External Checkout (createExternalCheckout) para confirmar o callback de status, ou sempre que precisar ler a configuração operacional da loja. Para identidade/branding/tema, use shopBySlug.\nAutenticação: x-api-key + Authorization (token de signIn). A loja é resolvida a partir da sua conta autenticada — não envie nenhum argumento de loja, esta operação não recebe argumentos.
\nArgumentos
\nNenhum. shopSettings não recebe argumentos — a loja é determinada pela sua autenticação.
\nRetorno
\nShopSettings!:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ntresCliques | \nTresCliquesSettings | \nConfiguração de callback do External Checkout. Sempre presente na resposta — se ainda não configurado, vem com os campos abaixo como string vazia (\"\"), nunca null. | \n
\n\ntresCliques.callbackUrl | \nString | \nURL para onde a Unbox envia atualizações de status de pedidos criados via createExternalCheckout. \"\" se ainda não configurado. | \n
\n\ntresCliques.callbackKey | \nString | \nChave usada para assinar as notificações enviadas a callbackUrl. \"\" se ainda não configurado. | \n
\n\n
\n
Além de tresCliques, a resposta traz flags operacionais de negócio, entre elas:
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ngenerateInvoice, generateInvoiceOnPaymentApproval | \nBoolean | \nSe e quando a nota fiscal é emitida automaticamente. | \n
\n\nenableFraudPrevention | \nBoolean | \nPrevenção de fraude ativa. | \n
\n\ndefaultTaxCode, primaryTaxServiceName, fallbackTaxServiceName | \nString | \nConfiguração fiscal/tributária. | \n
\n\nallowLegalPersonSales | \nBoolean | \nPermite venda a pessoa jurídica. | \n
\n\ncanSellVariantWithoutInventory | \nBoolean | \nPermite vender variante sem estoque. | \n
\n\nshowOutOfStockCatalogs | \nBoolean | \nExibe itens esgotados no catálogo. | \n
\n\nallowAnonymousRecurringOrders | \nBoolean | \nPermite assinaturas de comprador anônimo. | \n
\n\ndiscountPerCart | \nBoolean | \nRegra de desconto por carrinho. | \n
\n\nshouldNavigationTreeItemsBe* | \nBoolean | \nVisibilidade dos itens da árvore de navegação (admin/público/secundário). | \n
\n\n
\n
\nCredenciais de gateways de pagamento e integrações (Pagar.me, Malga, Zoop, Bling, Omie, Intelipost, etc.) não são retornadas por esta operação — são omitidas por segurança. tresCliques.callbackKey é a única chave presente, por ser a sua própria chave de assinatura do External Checkout.
\n
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha.
\n
\nNotas
\n\n- Somente leitura. Esta API não expõe uma mutation para alterar
ShopSettings; a configuração de tresCliques é feita pelo seu contato Unbox durante o onboarding. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"48851a9a-8981-46cf-a5d6-251c8b7fb446","name":"200 - shopSettings","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopSettings {\n shopSettings {\n tresCliques {\n callbackUrl\n callbackKey\n }\n showOutOfStockCatalogs\n loginWithCustomDomain\n discountPerCart\n intelipostProductsNature\n intelipostRecurrentProductCategory\n canSellVariantWithoutInventory\n saveShippingLabelToStorage\n shouldNavigationTreeItemsBeAdminOnly\n shouldNavigationTreeItemsBePubliclyVisible\n shouldNavigationTreeItemsBeSecondaryNavOnly\n enableFraudPrevention\n generateInvoice\n generateInvoiceOnPaymentApproval\n allowLegalPersonSales\n maxInvoiceRetryAttempts\n invoiceIssueAttemptsDelayInMinutes\n allowAnonymousRecurringOrders\n doNotUse\n isShippingRatesFulfillmentEnabled\n shopTrialPeriod\n createdAt\n updatedAt\n defaultTaxCode\n fallbackTaxServiceName\n primaryTaxServiceName\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## shopSettings\n\n**Propósito:** Retorna as configurações operacionais da sua loja — faturamento/nota fiscal, impostos, estoque, assinaturas, navegação e a integração de callback do External Checkout (`tresCliques`).\n**Quando usar:** Consulte antes de operar o External Checkout (`createExternalCheckout`) para confirmar o callback de status, ou sempre que precisar ler a configuração operacional da loja. Para identidade/branding/tema, use `shopBySlug`.\n**Autenticação:** `x-api-key` + `Authorization` (token de `signIn`). A loja é resolvida a partir da sua conta autenticada — **não envie nenhum argumento de loja**, esta operação não recebe argumentos.\n\n### Argumentos\n\nNenhum. `shopSettings` não recebe argumentos — a loja é determinada pela sua autenticação.\n\n### Retorno\n\n`ShopSettings!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tresCliques` | `TresCliquesSettings` | Configuração de callback do External Checkout. Sempre presente na resposta — se ainda não configurado, vem com os campos abaixo como string vazia (`\"\"`), nunca `null`. |\n| `tresCliques.callbackUrl` | `String` | URL para onde a Unbox envia atualizações de status de pedidos criados via `createExternalCheckout`. `\"\"` se ainda não configurado. |\n| `tresCliques.callbackKey` | `String` | Chave usada para assinar as notificações enviadas a `callbackUrl`. `\"\"` se ainda não configurado. |\n\nAlém de `tresCliques`, a resposta traz flags operacionais de negócio, entre elas:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- |\n| `generateInvoice`, `generateInvoiceOnPaymentApproval` | `Boolean` | Se e quando a nota fiscal é emitida automaticamente. |\n| `enableFraudPrevention` | `Boolean` | Prevenção de fraude ativa. |\n| `defaultTaxCode`, `primaryTaxServiceName`, `fallbackTaxServiceName` | `String` | Configuração fiscal/tributária. |\n| `allowLegalPersonSales` | `Boolean` | Permite venda a pessoa jurídica. |\n| `canSellVariantWithoutInventory` | `Boolean` | Permite vender variante sem estoque. |\n| `showOutOfStockCatalogs` | `Boolean` | Exibe itens esgotados no catálogo. |\n| `allowAnonymousRecurringOrders` | `Boolean` | Permite assinaturas de comprador anônimo. |\n| `discountPerCart` | `Boolean` | Regra de desconto por carrinho. |\n| `shouldNavigationTreeItemsBe*` | `Boolean` | Visibilidade dos itens da árvore de navegação (admin/público/secundário). |\n\n> Credenciais de gateways de pagamento e integrações (Pagar.me, Malga, Zoop, Bling, Omie, Intelipost, etc.) **não** são retornadas por esta operação — são omitidas por segurança. `tresCliques.callbackKey` é a única chave presente, por ser a sua própria chave de assinatura do External Checkout.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Somente leitura.** Esta API não expõe uma mutation para alterar `ShopSettings`; a configuração de `tresCliques` é feita pelo seu contato Unbox durante o onboarding."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shopSettings\": {\n \"tresCliques\": {\n \"callbackUrl\": \"https://exemplo.com\",\n \"callbackKey\": \"Example_String\"\n },\n \"showOutOfStockCatalogs\": true,\n \"loginWithCustomDomain\": true,\n \"discountPerCart\": true,\n \"intelipostProductsNature\": \"Example_String\",\n \"intelipostRecurrentProductCategory\": \"Example_String\",\n \"canSellVariantWithoutInventory\": true,\n \"saveShippingLabelToStorage\": true,\n \"shouldNavigationTreeItemsBeAdminOnly\": true,\n \"shouldNavigationTreeItemsBePubliclyVisible\": true,\n \"shouldNavigationTreeItemsBeSecondaryNavOnly\": true,\n \"enableFraudPrevention\": true,\n \"generateInvoice\": true,\n \"generateInvoiceOnPaymentApproval\": true,\n \"allowLegalPersonSales\": true,\n \"maxInvoiceRetryAttempts\": 10,\n \"invoiceIssueAttemptsDelayInMinutes\": 10,\n \"allowAnonymousRecurringOrders\": true,\n \"doNotUse\": \"Example_String\",\n \"isShippingRatesFulfillmentEnabled\": true,\n \"shopTrialPeriod\": 10,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"defaultTaxCode\": \"Example_String\",\n \"fallbackTaxServiceName\": \"Example_String\",\n \"primaryTaxServiceName\": \"Example_String\"\n }\n }\n}"},{"id":"9690c03e-cab1-458c-88bf-5ba1407ab9dc","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopSettings {\n shopSettings {\n tresCliques {\n callbackUrl\n callbackKey\n }\n showOutOfStockCatalogs\n loginWithCustomDomain\n discountPerCart\n intelipostProductsNature\n intelipostRecurrentProductCategory\n canSellVariantWithoutInventory\n saveShippingLabelToStorage\n shouldNavigationTreeItemsBeAdminOnly\n shouldNavigationTreeItemsBePubliclyVisible\n shouldNavigationTreeItemsBeSecondaryNavOnly\n enableFraudPrevention\n generateInvoice\n generateInvoiceOnPaymentApproval\n allowLegalPersonSales\n maxInvoiceRetryAttempts\n invoiceIssueAttemptsDelayInMinutes\n allowAnonymousRecurringOrders\n doNotUse\n isShippingRatesFulfillmentEnabled\n shopTrialPeriod\n createdAt\n updatedAt\n defaultTaxCode\n fallbackTaxServiceName\n primaryTaxServiceName\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## shopSettings\n\n**Propósito:** Retorna as configurações operacionais da sua loja — faturamento/nota fiscal, impostos, estoque, assinaturas, navegação e a integração de callback do External Checkout (`tresCliques`).\n**Quando usar:** Consulte antes de operar o External Checkout (`createExternalCheckout`) para confirmar o callback de status, ou sempre que precisar ler a configuração operacional da loja. Para identidade/branding/tema, use `shopBySlug`.\n**Autenticação:** `x-api-key` + `Authorization` (token de `signIn`). A loja é resolvida a partir da sua conta autenticada — **não envie nenhum argumento de loja**, esta operação não recebe argumentos.\n\n### Argumentos\n\nNenhum. `shopSettings` não recebe argumentos — a loja é determinada pela sua autenticação.\n\n### Retorno\n\n`ShopSettings!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tresCliques` | `TresCliquesSettings` | Configuração de callback do External Checkout. Sempre presente na resposta — se ainda não configurado, vem com os campos abaixo como string vazia (`\"\"`), nunca `null`. |\n| `tresCliques.callbackUrl` | `String` | URL para onde a Unbox envia atualizações de status de pedidos criados via `createExternalCheckout`. `\"\"` se ainda não configurado. |\n| `tresCliques.callbackKey` | `String` | Chave usada para assinar as notificações enviadas a `callbackUrl`. `\"\"` se ainda não configurado. |\n\nAlém de `tresCliques`, a resposta traz flags operacionais de negócio, entre elas:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- |\n| `generateInvoice`, `generateInvoiceOnPaymentApproval` | `Boolean` | Se e quando a nota fiscal é emitida automaticamente. |\n| `enableFraudPrevention` | `Boolean` | Prevenção de fraude ativa. |\n| `defaultTaxCode`, `primaryTaxServiceName`, `fallbackTaxServiceName` | `String` | Configuração fiscal/tributária. |\n| `allowLegalPersonSales` | `Boolean` | Permite venda a pessoa jurídica. |\n| `canSellVariantWithoutInventory` | `Boolean` | Permite vender variante sem estoque. |\n| `showOutOfStockCatalogs` | `Boolean` | Exibe itens esgotados no catálogo. |\n| `allowAnonymousRecurringOrders` | `Boolean` | Permite assinaturas de comprador anônimo. |\n| `discountPerCart` | `Boolean` | Regra de desconto por carrinho. |\n| `shouldNavigationTreeItemsBe*` | `Boolean` | Visibilidade dos itens da árvore de navegação (admin/público/secundário). |\n\n> Credenciais de gateways de pagamento e integrações (Pagar.me, Malga, Zoop, Bling, Omie, Intelipost, etc.) **não** são retornadas por esta operação — são omitidas por segurança. `tresCliques.callbackKey` é a única chave presente, por ser a sua própria chave de assinatura do External Checkout.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Somente leitura.** Esta API não expõe uma mutation para alterar `ShopSettings`; a configuração de `tresCliques` é feita pelo seu contato Unbox durante o onboarding."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"88a198e9-966d-46ae-86db-40ba312f9518","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopSettings {\n shopSettings {\n tresCliques {\n callbackUrl\n callbackKey\n }\n showOutOfStockCatalogs\n loginWithCustomDomain\n discountPerCart\n intelipostProductsNature\n intelipostRecurrentProductCategory\n canSellVariantWithoutInventory\n saveShippingLabelToStorage\n shouldNavigationTreeItemsBeAdminOnly\n shouldNavigationTreeItemsBePubliclyVisible\n shouldNavigationTreeItemsBeSecondaryNavOnly\n enableFraudPrevention\n generateInvoice\n generateInvoiceOnPaymentApproval\n allowLegalPersonSales\n maxInvoiceRetryAttempts\n invoiceIssueAttemptsDelayInMinutes\n allowAnonymousRecurringOrders\n doNotUse\n isShippingRatesFulfillmentEnabled\n shopTrialPeriod\n createdAt\n updatedAt\n defaultTaxCode\n fallbackTaxServiceName\n primaryTaxServiceName\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## shopSettings\n\n**Propósito:** Retorna as configurações operacionais da sua loja — faturamento/nota fiscal, impostos, estoque, assinaturas, navegação e a integração de callback do External Checkout (`tresCliques`).\n**Quando usar:** Consulte antes de operar o External Checkout (`createExternalCheckout`) para confirmar o callback de status, ou sempre que precisar ler a configuração operacional da loja. Para identidade/branding/tema, use `shopBySlug`.\n**Autenticação:** `x-api-key` + `Authorization` (token de `signIn`). A loja é resolvida a partir da sua conta autenticada — **não envie nenhum argumento de loja**, esta operação não recebe argumentos.\n\n### Argumentos\n\nNenhum. `shopSettings` não recebe argumentos — a loja é determinada pela sua autenticação.\n\n### Retorno\n\n`ShopSettings!`:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `tresCliques` | `TresCliquesSettings` | Configuração de callback do External Checkout. Sempre presente na resposta — se ainda não configurado, vem com os campos abaixo como string vazia (`\"\"`), nunca `null`. |\n| `tresCliques.callbackUrl` | `String` | URL para onde a Unbox envia atualizações de status de pedidos criados via `createExternalCheckout`. `\"\"` se ainda não configurado. |\n| `tresCliques.callbackKey` | `String` | Chave usada para assinar as notificações enviadas a `callbackUrl`. `\"\"` se ainda não configurado. |\n\nAlém de `tresCliques`, a resposta traz flags operacionais de negócio, entre elas:\n\n| Propriedade | Tipo | Descrição |\n| ------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- |\n| `generateInvoice`, `generateInvoiceOnPaymentApproval` | `Boolean` | Se e quando a nota fiscal é emitida automaticamente. |\n| `enableFraudPrevention` | `Boolean` | Prevenção de fraude ativa. |\n| `defaultTaxCode`, `primaryTaxServiceName`, `fallbackTaxServiceName` | `String` | Configuração fiscal/tributária. |\n| `allowLegalPersonSales` | `Boolean` | Permite venda a pessoa jurídica. |\n| `canSellVariantWithoutInventory` | `Boolean` | Permite vender variante sem estoque. |\n| `showOutOfStockCatalogs` | `Boolean` | Exibe itens esgotados no catálogo. |\n| `allowAnonymousRecurringOrders` | `Boolean` | Permite assinaturas de comprador anônimo. |\n| `discountPerCart` | `Boolean` | Regra de desconto por carrinho. |\n| `shouldNavigationTreeItemsBe*` | `Boolean` | Visibilidade dos itens da árvore de navegação (admin/público/secundário). |\n\n> Credenciais de gateways de pagamento e integrações (Pagar.me, Malga, Zoop, Bling, Omie, Intelipost, etc.) **não** são retornadas por esta operação — são omitidas por segurança. `tresCliques.callbackKey` é a única chave presente, por ser a sua própria chave de assinatura do External Checkout.\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha.\n\n### Notas\n\n- **Somente leitura.** Esta API não expõe uma mutation para alterar `ShopSettings`; a configuração de `tresCliques` é feita pelo seu contato Unbox durante o onboarding."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"1e5582ff-2d95-52ac-9426-032f8ff5b73d"}],"id":"90e1ce65-4b71-49ef-82a9-88e9739b3867","_postman_id":"90e1ce65-4b71-49ef-82a9-88e9739b3867","description":""}],"id":"13f797ba-bdc5-43ad-8be8-dc41d0743c97","description":"Settings
\nConfigurações da loja disponíveis para leitura via API. Hoje expõe as configurações de integração do External Checkout (tresCliques); novas configurações podem ser adicionadas aqui conforme a API evoluir.
\nTipos e enums compartilhados
\n\n\n\n| Tipo | \nCampos | \nDescrição | \n
\n\n\n\nShopSettings | \ntresCliques | \nObjeto raiz de configurações da loja. Extensível: novos campos podem ser adicionados por outras áreas da plataforma sem quebrar clientes existentes que não os utilizam. | \n
\n\nTresCliquesSettings | \ncallbackUrl, callbackKey | \nCredenciais/endpoint usados internamente pela Unbox para notificar o parceiro sobre atualizações de status de pedidos criados via External Checkout (createExternalCheckout). | \n
\n\n
\n
Regras de negócio
\n\n- Somente leitura. Não há mutation exposta nesta API para alterar
ShopSettings — a configuração de tresCliques (callback de status de pedido do External Checkout) é feita pelo seu contato Unbox durante o onboarding da integração. \ntresCliques pode vir com callbackUrl/callbackKey vazios (\"\") se o callback do External Checkout ainda não tiver sido configurado para a loja — não use isso como indicativo de erro, apenas de integração pendente.
\n","_postman_id":"13f797ba-bdc5-43ad-8be8-dc41d0743c97"},{"name":"Shops","item":[{"name":"Query","item":[{"name":"[Query] shopBySlug","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns shopBySlug data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"shopBySlug\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"shopBySlug returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.shopBySlug;"," "," if (data !== null) {"," if (data.shopSales !== undefined && data.shopSales !== null) {"," pm.expect(data.shopSales).to.be.an(\"array\");"," }"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.brandAssets !== undefined && data.brandAssets !== null) {"," pm.expect(data.brandAssets).to.be.an(\"object\");"," }"," if (data.defaultParcelSize !== undefined && data.defaultParcelSize !== null) {"," pm.expect(data.defaultParcelSize).to.be.an(\"object\");"," }"," if (data.description !== undefined && data.description !== null) {"," pm.expect(typeof data.description).to.equal(\"string\");"," }"," if (data.isCompany !== undefined && data.isCompany !== null) {"," pm.expect(typeof data.isCompany).to.equal(\"boolean\");"," }"," if (data.storefrontTemplate !== undefined && data.storefrontTemplate !== null) {"," pm.expect(data.storefrontTemplate).to.be.an(\"object\");"," }"," if (data.keywords !== undefined && data.keywords !== null) {"," pm.expect(typeof data.keywords).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"name\");"," if (data.name !== undefined && data.name !== null) {"," pm.expect(typeof data.name).to.equal(\"string\");"," }"," if (data.recurringOrdersPolicy !== undefined && data.recurringOrdersPolicy !== null) {"," pm.expect(data.recurringOrdersPolicy).to.be.an(\"object\");"," }"," }","});"]}}],"id":"c2cd5e5f-2ea7-55f6-85c5-7080d395bdad","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopBySlug {\n shopBySlug {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"shopBySlug
\nPropósito: Retorna os dados da sua loja — identidade, branding, configuração de storefront e flags comerciais — para renderizar o cabeçalho/tema do seu canal e conhecer as capacidades da loja.\nQuando usar: Ao inicializar o seu storefront (logo, cores, nome, moeda, domínios, template) ou para ler a configuração pública da loja. Para as configurações operacionais detalhadas (fiscal, faturamento, callback do External Checkout), use shopSettings.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir da sua conta autenticada — o slug é derivado do seu token na borda, não há argumento nesta operação e você não o envia. Envie sempre um Authorization válido: sem ele o escopo de loja não é aplicado e a chamada falha.
\nArgumentos
\nNenhum. shopBySlug não recebe argumentos — a loja é determinada pela sua autenticação (o slug vem do seu token).
\nRetorno
\nShop — os dados da sua loja. Principais grupos de campos:
\n\n\n\n| Grupo | \nCampos | \nDescrição | \n
\n\n\n\n| Identidade | \n_id, name, slug, description, keywords, businessSector, isCompany | \nIdentificação e classificação da loja. | \n
\n\n| Localização | \nlanguage, timezone, currency, unitsOfLength, unitsOfMeasure, baseUOL, baseUOM | \nIdioma, fuso, moeda e unidades. | \n
\n\n| Branding | \nbrandAssets, shopLogoUrls, social | \nLogotipos, identidade visual e redes sociais. | \n
\n\n| Storefront | \nstorefrontTemplate, storefrontUrls, storeTemplateUrl, defaultNavigationTree, defaultNavigationTreeId, sitemap, tags | \nTemplate, URLs, árvore de navegação e sitemap do canal. | \n
\n\n| Comercial | \nacceptsBoleto, acceptsCreditCard, allowGuestCheckout, recurringOrdersPolicy, defaultParcelSize, fulfillmentOptions, settings | \nMeios de pagamento aceitos, política de assinaturas, parcela padrão e settings públicos (ShopPublicSettings: maxInstallments, showOutOfStockCatalogs, etc.). | \n
\n\n| Operacional | \ndomains, enabledTaskGroups, trialRemainingDays, shopSales, createdAt | \nDomínios, grupos de tarefas habilitados e metadados. | \n
\n\n
\n
\nDados internos da Unbox (qualificação de lead, onboarding, assinatura, e-mails, endereços, integrações/credenciais) não são expostos por esta operação. Para credenciais/configuração de gateway, elas não são retornadas por design (segurança).
\n
\nErros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nAuthorization ausente ou inválido. | \nSem um token válido o escopo de loja não é derivado e a chamada falha. Refaça signIn e reenvie. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio.
\n
\nNotas
\n\n- Retorna sempre a sua loja (a do token). Não é possível consultar outra loja por slug — o
slug é injetado a partir da sua identidade autenticada, não enviado por você. \n- Para configurações operacionais (fiscal, faturamento, callback do External Checkout), prefira
shopSettings. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6674fa5e-7903-46af-ad2e-1c7bced0d961","name":"200 - shopBySlug","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopBySlug {\n shopBySlug {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## shopBySlug\n\n**Propósito:** Retorna os dados da sua loja — identidade, branding, configuração de storefront e flags comerciais — para renderizar o cabeçalho/tema do seu canal e conhecer as capacidades da loja.\n**Quando usar:** Ao inicializar o seu storefront (logo, cores, nome, moeda, domínios, template) ou para ler a configuração pública da loja. Para as configurações operacionais detalhadas (fiscal, faturamento, callback do External Checkout), use `shopSettings`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — o `slug` é derivado do seu token na borda, **não há argumento nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\nNenhum. `shopBySlug` não recebe argumentos — a loja é determinada pela sua autenticação (o `slug` vem do seu token).\n\n### Retorno\n\n`Shop` — os dados da sua loja. Principais grupos de campos:\n\n| Grupo | Campos | Descrição |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Identidade | `_id`, `name`, `slug`, `description`, `keywords`, `businessSector`, `isCompany` | Identificação e classificação da loja. |\n| Localização | `language`, `timezone`, `currency`, `unitsOfLength`, `unitsOfMeasure`, `baseUOL`, `baseUOM` | Idioma, fuso, moeda e unidades. |\n| Branding | `brandAssets`, `shopLogoUrls`, `social` | Logotipos, identidade visual e redes sociais. |\n| Storefront | `storefrontTemplate`, `storefrontUrls`, `storeTemplateUrl`, `defaultNavigationTree`, `defaultNavigationTreeId`, `sitemap`, `tags` | Template, URLs, árvore de navegação e sitemap do canal. |\n| Comercial | `acceptsBoleto`, `acceptsCreditCard`, `allowGuestCheckout`, `recurringOrdersPolicy`, `defaultParcelSize`, `fulfillmentOptions`, `settings` | Meios de pagamento aceitos, política de assinaturas, parcela padrão e `settings` públicos (`ShopPublicSettings`: `maxInstallments`, `showOutOfStockCatalogs`, etc.). |\n| Operacional | `domains`, `enabledTaskGroups`, `trialRemainingDays`, `shopSales`, `createdAt` | Domínios, grupos de tarefas habilitados e metadados. |\n\n> Dados internos da Unbox (qualificação de lead, onboarding, assinatura, e-mails, endereços, integrações/credenciais) **não** são expostos por esta operação. Para credenciais/configuração de gateway, elas não são retornadas por design (segurança).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Retorna sempre a **sua** loja (a do token). Não é possível consultar outra loja por slug — o `slug` é injetado a partir da sua identidade autenticada, não enviado por você.\n- Para configurações operacionais (fiscal, faturamento, callback do External Checkout), prefira `shopSettings`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"shopBySlug\": {\n \"shopSales\": [\n {\n \"_id\": \"Example_ID\",\n \"code\": \"Example_String\",\n \"description\": \"Example_String\",\n \"discountMethod\": \"CODE\",\n \"label\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"_id\": \"Example_ID\",\n \"brandAssets\": {\n \"navbarBrandImageId\": \"Example_String\"\n },\n \"defaultParcelSize\": {\n \"height\": 99.99,\n \"length\": 99.99,\n \"weight\": 99.99,\n \"width\": 99.99\n },\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"storefrontTemplate\": {\n \"_id\": \"Example_ID\",\n \"shopId\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n },\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"recurringOrdersPolicy\": {\n \"_id\": \"Example_String\",\n \"shopId\": \"Example_String\",\n \"enabled\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"minDaysIntervalBetweenCycles\": 10,\n \"keepOrderPricingPolicy\": true,\n \"termsAndConditions\": \"Example_String\"\n },\n \"shopLogoUrls\": {\n \"primaryShopLogoUrl\": \"https://exemplo.com\"\n },\n \"social\": {\n \"instagramUrl\": \"https://exemplo.com\",\n \"facebookUrl\": \"https://exemplo.com\"\n },\n \"slug\": \"Example_String\",\n \"storefrontUrls\": {\n \"storefrontAccountProfileUrl\": \"https://exemplo.com\",\n \"storefrontHomeUrl\": \"https://exemplo.com\",\n \"storefrontLoginUrl\": \"https://exemplo.com\",\n \"storefrontOrderUrl\": \"https://exemplo.com\",\n \"storefrontOrdersUrl\": \"https://exemplo.com\"\n },\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"providers\": {\n \"logistics\": \"INTELIPOST\",\n \"payment\": \"ZOOP\",\n \"products\": \"ERP\",\n \"checkout\": [\n \"SHOPIFY\"\n ],\n \"invoice\": \"ERP\",\n \"erp\": \"OMIE\",\n \"marketing\": [\n \"RD_STATION\"\n ]\n },\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"fulfillmentOptions\": [\n {\n \"_id\": \"Example_ID\",\n \"name\": \"Example_String\",\n \"description\": \"Example_String\",\n \"label\": \"Example_String\",\n \"carrier\": \"Example_String\",\n \"enabled\": true,\n \"classification\": \"FULFILLMENT_OPTION\",\n \"type\": \"CORREIOS_PAC\",\n \"shopId\": \"Example_ID\",\n \"additionalDaysToDeliver\": 10,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"ordersCount\": 10,\n \"missingCredentials\": true\n }\n ],\n \"settings\": {\n \"allowLegalPersonSales\": true,\n \"showOutOfStockCatalogs\": true,\n \"allowAnonymousRecurringOrders\": true,\n \"maxInstallments\": 10,\n \"threeDSActive\": true,\n \"unboxPayProviders\": [\n \"ZOOP\"\n ]\n },\n \"dashboards\": [\n {\n \"url\": \"https://exemplo.com\",\n \"title\": \"Example_String\",\n \"header\": \"Example_String\",\n \"category\": \"MAIN\"\n }\n ],\n \"sitemap\": \"Example_String\",\n \"tags\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n }\n}"},{"id":"8953bae1-bf29-4fe5-8382-44f8a49e6279","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ShopBySlug {\n shopBySlug {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n createdAt\n description\n name\n slug\n updatedAt\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n additionalDaysToDeliver\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n shippingValue {\n amount\n displayAmount\n }\n }\n description\n items {\n _id\n images {\n url\n altText\n }\n parcel {\n weight\n height\n width\n length\n }\n title\n description\n quantity\n price {\n amount\n displayAmount\n }\n subtotal {\n amount\n displayAmount\n }\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n orderTotal {\n amount\n displayAmount\n }\n orderSummary {\n type\n description\n }\n successCallbackURL\n discount {\n discountId\n code\n method\n }\n shopSales {\n discountId\n discountCalculationMethod\n label\n description\n }\n installmentAmount {\n amount\n displayAmount\n }\n orderTotalBeforeInterest {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n addedAt\n cancelReason\n createdAt\n isRecurring\n isDiscountedBonusItem\n optionTitle\n productSlug\n productTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n productType\n productVendor\n quantity\n status\n title\n updatedAt\n variantTitle\n variantTItles\n isTaxable\n taxCode\n thumbnail\n }\n }\n }\n selectedFulfillmentOption {\n fulfillmentMethod {\n _id\n carrier\n displayName\n fulfillmentTypes\n group\n name\n type\n daysToDeliver\n description\n label\n }\n handlingPrice {\n amount\n displayAmount\n }\n discountPrice {\n amount\n displayAmount\n }\n price {\n amount\n displayAmount\n }\n }\n shippingLabel {\n url\n content\n }\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n event {\n createdAt\n createdBy\n triggeredBy\n comment\n }\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n tax {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n taxes {\n _id\n jurisdictionId\n sourcing\n taxName\n }\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n history {\n status\n createdAt\n createdBy\n triggeredBy\n }\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalSavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n installmentAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n interest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalBeforeInterest {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n itemTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n taxableAmount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n total {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n surchargeTotal {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n compareAtPrice {\n amount\n displayAmount\n }\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n productConfiguration {\n productId\n productVariantId\n productErpCode\n variantErpCode\n }\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n URLs {\n large\n medium\n original\n small\n thumbnail\n }\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n }\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## shopBySlug\n\n**Propósito:** Retorna os dados da sua loja — identidade, branding, configuração de storefront e flags comerciais — para renderizar o cabeçalho/tema do seu canal e conhecer as capacidades da loja.\n**Quando usar:** Ao inicializar o seu storefront (logo, cores, nome, moeda, domínios, template) ou para ler a configuração pública da loja. Para as configurações operacionais detalhadas (fiscal, faturamento, callback do External Checkout), use `shopSettings`.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir da sua conta autenticada — o `slug` é derivado do seu token na borda, **não há argumento nesta operação e você não o envia**. Envie sempre um `Authorization` válido: sem ele o escopo de loja não é aplicado e a chamada falha.\n\n### Argumentos\n\nNenhum. `shopBySlug` não recebe argumentos — a loja é determinada pela sua autenticação (o `slug` vem do seu token).\n\n### Retorno\n\n`Shop` — os dados da sua loja. Principais grupos de campos:\n\n| Grupo | Campos | Descrição |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Identidade | `_id`, `name`, `slug`, `description`, `keywords`, `businessSector`, `isCompany` | Identificação e classificação da loja. |\n| Localização | `language`, `timezone`, `currency`, `unitsOfLength`, `unitsOfMeasure`, `baseUOL`, `baseUOM` | Idioma, fuso, moeda e unidades. |\n| Branding | `brandAssets`, `shopLogoUrls`, `social` | Logotipos, identidade visual e redes sociais. |\n| Storefront | `storefrontTemplate`, `storefrontUrls`, `storeTemplateUrl`, `defaultNavigationTree`, `defaultNavigationTreeId`, `sitemap`, `tags` | Template, URLs, árvore de navegação e sitemap do canal. |\n| Comercial | `acceptsBoleto`, `acceptsCreditCard`, `allowGuestCheckout`, `recurringOrdersPolicy`, `defaultParcelSize`, `fulfillmentOptions`, `settings` | Meios de pagamento aceitos, política de assinaturas, parcela padrão e `settings` públicos (`ShopPublicSettings`: `maxInstallments`, `showOutOfStockCatalogs`, etc.). |\n| Operacional | `domains`, `enabledTaskGroups`, `trialRemainingDays`, `shopSales`, `createdAt` | Domínios, grupos de tarefas habilitados e metadados. |\n\n> Dados internos da Unbox (qualificação de lead, onboarding, assinatura, e-mails, endereços, integrações/credenciais) **não** são expostos por esta operação. Para credenciais/configuração de gateway, elas não são retornadas por design (segurança).\n\n### Erros\n\n| Código | Condição | O que fazer |\n| -------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente ou inválido. | Sem um token válido o escopo de loja não é derivado e a chamada falha. Refaça `signIn` e reenvie. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- Retorna sempre a **sua** loja (a do token). Não é possível consultar outra loja por slug — o `slug` é injetado a partir da sua identidade autenticada, não enviado por você.\n- Para configurações operacionais (fiscal, faturamento, callback do External Checkout), prefira `shopSettings`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"c2cd5e5f-2ea7-55f6-85c5-7080d395bdad"}],"id":"3cf1b816-1bb4-4d3b-b14e-20b92e0108a6","_postman_id":"3cf1b816-1bb4-4d3b-b14e-20b92e0108a6","description":""}],"id":"4eb36411-0d32-428f-a994-cf705703a15d","description":"Shops
\nStatistics
\n\n- Queries: 1
\n- Mutations: 0
\n
\n","_postman_id":"4eb36411-0d32-428f-a994-cf705703a15d"},{"name":"Store Templates","item":[{"name":"Query","item":[{"name":"[Query] listCatalogDescriptionTemplates","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns listCatalogDescriptionTemplates data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"listCatalogDescriptionTemplates\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"listCatalogDescriptionTemplates returns valid array structure\", function() {"," const json = pm.response.json();"," const data = json.data.listCatalogDescriptionTemplates;"," "," if (data !== null && Array.isArray(data) && data.length > 0) {"," const item = data[0];"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.name !== undefined && data.name !== null) {"," pm.expect(typeof data.name).to.equal(\"string\");"," }"," if (data.path !== undefined && data.path !== null) {"," pm.expect(typeof data.path).to.equal(\"string\");"," }"," if (data.productId !== undefined && data.productId !== null) {"," pm.expect(typeof data.productId).to.equal(\"string\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," if (data.currentHash !== undefined && data.currentHash !== null) {"," pm.expect(typeof data.currentHash).to.equal(\"string\");"," }"," if (data.publishedHash !== undefined && data.publishedHash !== null) {"," pm.expect(typeof data.publishedHash).to.equal(\"string\");"," }"," if (data.lastPublishedAt !== undefined && data.lastPublishedAt !== null) {"," pm.expect(typeof data.lastPublishedAt).to.equal(\"string\");"," }"," if (data.lastPublishedAt) {"," pm.expect(new Date(data.lastPublishedAt).toString()).to.not.equal(\"Invalid Date\");"," }"," }","});"]}}],"id":"7901c6a8-6ce1-5d33-9c31-c8b02187a640","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListCatalogDescriptionTemplates {\n listCatalogDescriptionTemplates {\n _id\n name\n path\n productId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"listCatalogDescriptionTemplates
\nPropósito: Lista os templates de página customizada vinculados a produtos da loja autenticada, com o status de publicação de cada um.\nQuando usar: Para auditar quais produtos têm uma página de catálogo customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.
\nArgumentos
\nEsta query não recebe nenhum argumento.
\nRetorno
\n[CatalogDescriptionTemplateListItem] — array simples (não paginado). Vem vazio ([]) se a loja não tiver nenhum template de descrição de catálogo configurado.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nString! | \nIdentificador interno do template. | \n
\n\nname | \nString | \nNome atribuído à página do template. Segundo a definição do campo, ele é usado como título enquanto a página ainda não tem produto vinculado; depois de vinculada, a exibição normalmente passa a usar o título do próprio produto. | \n
\n\npath | \nString | \nCaminho (slug) onde a página fica acessível na loja. | \n
\n\nproductId | \nString | \nID do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por ID de produto — mutuamente exclusivo com erpCode. | \n
\n\nerpCode | \nString | \nCódigo ERP do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com productId. | \n
\n\ncurrentHash | \nString | \nHash do conteúdo atual do template, incluindo alterações ainda não publicadas. | \n
\n\npublishedHash | \nString | \nHash do conteúdo que está publicado (no ar). Compare com currentHash: valores diferentes indicam alterações pendentes de publicação. | \n
\n\nlastPublishedAt | \nAWSDateTime | \nData/hora da última publicação. null se o template nunca foi publicado. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo aqui.
\n
\nNotas
\n\n- Cada item representa um template já configurado; produtos sem template customizado não aparecem no array.
\n- Use
currentHash !== publishedHash para saber se há alterações aguardando publicação. \n- Exatamente um entre
productId e erpCode vem preenchido por item — nunca os dois, nunca nenhum. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e257cb5b-3c0b-41f4-bdb3-bed78aae0743","name":"200 - listCatalogDescriptionTemplates","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListCatalogDescriptionTemplates {\n listCatalogDescriptionTemplates {\n _id\n name\n path\n productId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listCatalogDescriptionTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a produtos da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais produtos têm uma página de catálogo customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[CatalogDescriptionTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de descrição de catálogo configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `name` | `String` | Nome atribuído à página do template. Segundo a definição do campo, ele é usado como título enquanto a página ainda não tem produto vinculado; depois de vinculada, a exibição normalmente passa a usar o título do próprio produto. |\n| `path` | `String` | Caminho (slug) onde a página fica acessível na loja. |\n| `productId` | `String` | ID do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por ID de produto — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `productId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; produtos sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `productId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"listCatalogDescriptionTemplates\": [\n {\n \"_id\": \"Example_String\",\n \"name\": \"Example_String\",\n \"path\": \"Example_String\",\n \"productId\": \"Example_String\",\n \"erpCode\": \"Example_String\",\n \"currentHash\": \"Example_String\",\n \"publishedHash\": \"Example_String\",\n \"lastPublishedAt\": \"2025-01-15T10:00:00Z\"\n }\n ]\n }\n}"},{"id":"fc3489e5-69f0-4abd-8c33-a210270402a1","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListCatalogDescriptionTemplates {\n listCatalogDescriptionTemplates {\n _id\n name\n path\n productId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listCatalogDescriptionTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a produtos da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais produtos têm uma página de catálogo customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[CatalogDescriptionTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de descrição de catálogo configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `name` | `String` | Nome atribuído à página do template. Segundo a definição do campo, ele é usado como título enquanto a página ainda não tem produto vinculado; depois de vinculada, a exibição normalmente passa a usar o título do próprio produto. |\n| `path` | `String` | Caminho (slug) onde a página fica acessível na loja. |\n| `productId` | `String` | ID do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por ID de produto — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `productId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; produtos sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `productId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"6e4c7618-acc2-4523-9e3f-2c554f2726cc","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListCatalogDescriptionTemplates {\n listCatalogDescriptionTemplates {\n _id\n name\n path\n productId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listCatalogDescriptionTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a produtos da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais produtos têm uma página de catálogo customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[CatalogDescriptionTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de descrição de catálogo configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `name` | `String` | Nome atribuído à página do template. Segundo a definição do campo, ele é usado como título enquanto a página ainda não tem produto vinculado; depois de vinculada, a exibição normalmente passa a usar o título do próprio produto. |\n| `path` | `String` | Caminho (slug) onde a página fica acessível na loja. |\n| `productId` | `String` | ID do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por ID de produto — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP do produto dono do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `productId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; produtos sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `productId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"7901c6a8-6ce1-5d33-9c31-c8b02187a640"},{"name":"[Query] listTagTemplates","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns listTagTemplates data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"listTagTemplates\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"listTagTemplates returns valid array structure\", function() {"," const json = pm.response.json();"," const data = json.data.listTagTemplates;"," "," if (data !== null && Array.isArray(data) && data.length > 0) {"," const item = data[0];"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.tagId !== undefined && data.tagId !== null) {"," pm.expect(typeof data.tagId).to.equal(\"string\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," if (data.currentHash !== undefined && data.currentHash !== null) {"," pm.expect(typeof data.currentHash).to.equal(\"string\");"," }"," if (data.publishedHash !== undefined && data.publishedHash !== null) {"," pm.expect(typeof data.publishedHash).to.equal(\"string\");"," }"," if (data.lastPublishedAt !== undefined && data.lastPublishedAt !== null) {"," pm.expect(typeof data.lastPublishedAt).to.equal(\"string\");"," }"," if (data.lastPublishedAt) {"," pm.expect(new Date(data.lastPublishedAt).toString()).to.not.equal(\"Invalid Date\");"," }"," }","});"]}}],"id":"aef7bca7-31bd-5e44-9bba-b3f03ba0343a","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListTagTemplates {\n listTagTemplates {\n _id\n tagId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"listTagTemplates
\nPropósito: Lista os templates de página customizada vinculados a tags/categorias da loja autenticada, com o status de publicação de cada um.\nQuando usar: Para auditar quais tags/categorias têm uma página customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\nAutenticação: x-api-key + Authorization. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.
\nArgumentos
\nEsta query não recebe nenhum argumento.
\nRetorno
\n[TagTemplateListItem] — array simples (não paginado). Vem vazio ([]) se a loja não tiver nenhum template de tag configurado.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nString! | \nIdentificador interno do template. | \n
\n\ntagId | \nString | \nID da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por ID de tag — mutuamente exclusivo com erpCode. | \n
\n\nerpCode | \nString | \nCódigo ERP da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com tagId. | \n
\n\ncurrentHash | \nString | \nHash do conteúdo atual do template, incluindo alterações ainda não publicadas. | \n
\n\npublishedHash | \nString | \nHash do conteúdo que está publicado (no ar). Compare com currentHash: valores diferentes indicam alterações pendentes de publicação. | \n
\n\nlastPublishedAt | \nAWSDateTime | \nData/hora da última publicação. null se o template nunca foi publicado. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo aqui.
\n
\nNotas
\n\n- Cada item representa um template já configurado; tags/categorias sem template customizado não aparecem no array.
\n- Use
currentHash !== publishedHash para saber se há alterações aguardando publicação. \n- Exatamente um entre
tagId e erpCode vem preenchido por item — nunca os dois, nunca nenhum. \n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"86773f93-27e7-4de2-be4e-69d9f318b3e6","name":"200 - listTagTemplates","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListTagTemplates {\n listTagTemplates {\n _id\n tagId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listTagTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a tags/categorias da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais tags/categorias têm uma página customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[TagTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de tag configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `tagId` | `String` | ID da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por ID de tag — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `tagId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; tags/categorias sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `tagId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"listTagTemplates\": [\n {\n \"_id\": \"Example_String\",\n \"tagId\": \"Example_String\",\n \"erpCode\": \"Example_String\",\n \"currentHash\": \"Example_String\",\n \"publishedHash\": \"Example_String\",\n \"lastPublishedAt\": \"2025-01-15T10:00:00Z\"\n }\n ]\n }\n}"},{"id":"7ccc539d-3e30-4c38-beb9-608a563f2616","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListTagTemplates {\n listTagTemplates {\n _id\n tagId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listTagTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a tags/categorias da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais tags/categorias têm uma página customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[TagTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de tag configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `tagId` | `String` | ID da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por ID de tag — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `tagId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; tags/categorias sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `tagId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"c97682ca-33f1-41e3-9f50-e2917717d339","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ListTagTemplates {\n listTagTemplates {\n _id\n tagId\n erpCode\n currentHash\n publishedHash\n lastPublishedAt\n }\n}","variables":"{}"}},"url":"{{base_url}}","description":"## listTagTemplates\n\n**Propósito:** Lista os templates de página customizada vinculados a tags/categorias da loja autenticada, com o status de publicação de cada um.\n**Quando usar:** Para auditar quais tags/categorias têm uma página customizada e se as alterações mais recentes já foram publicadas — por exemplo, antes de decidir se vale a pena avisar o lojista sobre um template com mudanças pendentes.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é resolvida a partir do token autenticado — não há argumento de loja nesta query.\n\n### Argumentos\n\nEsta query não recebe nenhum argumento.\n\n### Retorno\n\n`[TagTemplateListItem]` — array simples (**não paginado**). Vem vazio (`[]`) se a loja não tiver nenhum template de tag configurado.\n\n| Propriedade | Tipo | Descrição |\n| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador interno do template. |\n| `tagId` | `String` | ID da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por ID de tag — mutuamente exclusivo com `erpCode`. |\n| `erpCode` | `String` | Código ERP da tag/categoria dona do template. Vem preenchido apenas quando o vínculo foi feito por código ERP — mutuamente exclusivo com `tagId`. |\n| `currentHash` | `String` | Hash do conteúdo atual do template, incluindo alterações ainda não publicadas. |\n| `publishedHash` | `String` | Hash do conteúdo que está publicado (no ar). Compare com `currentHash`: valores diferentes indicam alterações pendentes de publicação. |\n| `lastPublishedAt` | `AWSDateTime` | Data/hora da última publicação. `null` se o template nunca foi publicado. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ------------------------------------------------------------------ |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo aqui.\n\n### Notas\n\n- Cada item representa um template já configurado; tags/categorias sem template customizado não aparecem no array.\n- Use `currentHash !== publishedHash` para saber se há alterações aguardando publicação.\n- Exatamente um entre `tagId` e `erpCode` vem preenchido por item — nunca os dois, nunca nenhum."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"aef7bca7-31bd-5e44-9bba-b3f03ba0343a"}],"id":"dc4c1af7-0222-4bf8-9c1c-05b654191082","_postman_id":"dc4c1af7-0222-4bf8-9c1c-05b654191082","description":""}],"id":"15c72609-3056-442c-8080-31f6cc3f88fa","description":"Store Templates
\nConsultas somente-leitura para verificar se um produto ou uma tag/categoria da loja tem uma página customizada (template) configurada, e se as últimas alterações desse template já foram publicadas. As duas queries deste grupo não recebem argumentos e retornam arrays simples (sem paginação) — a loja é sempre a que está autenticada no token.
\nTipos e enums compartilhados
\n\n\n\n| Tipo | \nCampos | \nDescrição | \n
\n\n\n\nCatalogDescriptionTemplateListItem | \n_id, name, path, productId, erpCode, currentHash, publishedHash, lastPublishedAt | \nUm template de página customizada vinculado a um produto da loja. | \n
\n\nTagTemplateListItem | \n_id, tagId, erpCode, currentHash, publishedHash, lastPublishedAt | \nUm template de página customizada vinculado a uma tag/categoria da loja. | \n
\n\n
\n
Ambos os tipos seguem o mesmo padrão de identificação e de status de publicação:
\n\n- Identificação do dono, mutuamente exclusiva: cada item é vinculado ao seu produto (ou tag) por ID ou por código ERP, nunca pelos dois ao mesmo tempo. Em
CatalogDescriptionTemplateListItem, exatamente um entre productId e erpCode vem preenchido (o outro vem null). Em TagTemplateListItem, o mesmo vale para tagId/erpCode. \n- Status de publicação via hash:
currentHash reflete o conteúdo mais recente do template (incluindo edições ainda não publicadas); publishedHash reflete o conteúdo que está de fato no ar. Quando os dois valores diferem, existem alterações pendentes de publicação. lastPublishedAt vem null se o template nunca foi publicado. \n
\nRegras de negócio
\n\n- Somente leitura e somente status/resumo. Estas queries não retornam o conteúdo completo do template (layout, seções, etc.) — apenas os metadados acima. Não há, nesta API, operações para criar, editar ou publicar templates; se precisar disso, fale com seu contato Unbox ou use o painel administrativo da loja.
\n- Sem paginação e sem filtros. Cada chamada retorna todos os templates da loja de uma vez. Se a loja tiver muitas páginas customizadas, espere arrays potencialmente grandes.
\n- Produto/tag sem template customizado simplesmente não aparece no array — a ausência de um item não é um erro, apenas indica que aquele produto ou tag usa a apresentação padrão da loja.
\n
\n","_postman_id":"15c72609-3056-442c-8080-31f6cc3f88fa"},{"name":"Tags","item":[{"name":"Query","item":[{"name":"[Query] tag","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns tag data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"tag\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"tag returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.tag;"," "," if (data !== null) {"," pm.expect(data).to.have.property(\"_id\");"," if (data._id !== undefined && data._id !== null) {"," pm.expect(typeof data._id).to.equal(\"string\");"," }"," if (data.erpCode !== undefined && data.erpCode !== null) {"," pm.expect(typeof data.erpCode).to.equal(\"string\");"," }"," pm.expect(data).to.have.property(\"createdAt\");"," if (data.createdAt !== undefined && data.createdAt !== null) {"," pm.expect(typeof data.createdAt).to.equal(\"string\");"," }"," if (data.createdAt) {"," pm.expect(new Date(data.createdAt).toString()).to.not.equal(\"Invalid Date\");"," }"," if (data.displayTitle !== undefined && data.displayTitle !== null) {"," pm.expect(typeof data.displayTitle).to.equal(\"string\");"," }"," if (data.description !== undefined && data.description !== null) {"," pm.expect(typeof data.description).to.equal(\"string\");"," }"," if (data.featuredProductIds !== undefined && data.featuredProductIds !== null) {"," pm.expect(data.featuredProductIds).to.be.an(\"array\");"," }"," if (data.heroMedia !== undefined && data.heroMedia !== null) {"," pm.expect(data.heroMedia).to.be.an(\"object\");"," }"," pm.expect(data).to.have.property(\"isDeleted\");"," if (data.isDeleted !== undefined && data.isDeleted !== null) {"," pm.expect(typeof data.isDeleted).to.equal(\"boolean\");"," }"," pm.expect(data).to.have.property(\"isTopLevel\");"," if (data.isTopLevel !== undefined && data.isTopLevel !== null) {"," pm.expect(typeof data.isTopLevel).to.equal(\"boolean\");"," }"," pm.expect(data).to.have.property(\"isVisible\");"," if (data.isVisible !== undefined && data.isVisible !== null) {"," pm.expect(typeof data.isVisible).to.equal(\"boolean\");"," }"," }","});"]}}],"id":"4ed6a284-6a82-524c-b441-1575db08cb41","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tag($slugOrId: String!, $shouldIncludeInvisible: Boolean) {\n tag(slugOrId: $slugOrId, shouldIncludeInvisible: $shouldIncludeInvisible) {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n}","variables":"{\n \"slugOrId\": \"Example_String\",\n \"shouldIncludeInvisible\": true\n}"}},"url":"{{base_url}}","description":"Returns a tag from a provided tag ID or slug. Tags with isVisible set to false are excluded by default.
\nType: 🔍 Query
\nParameters
\n\n\n\n| Name | \nType | \nDescription | \n
\n\n\n\nslugOrId | \nString! | \nSlug or ID of Tag | \n
\n\nshouldIncludeInvisible | \nBoolean | \nSet to true if you want to include tags that have isVisible set to false (default: false) | \n
\n\n
\n
Returns
\nTag
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a4161743-edbc-4e5d-9553-b1e0c63ede38","name":"200 - tag","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tag($slugOrId: String!, $shouldIncludeInvisible: Boolean) {\n tag(slugOrId: $slugOrId, shouldIncludeInvisible: $shouldIncludeInvisible) {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n}","variables":"{\n \"slugOrId\": \"Example_String\",\n \"shouldIncludeInvisible\": true\n}"}},"url":"{{base_url}}","description":"Returns a tag from a provided tag ID or slug. Tags with isVisible set to false are excluded by default.\n\n**Type:** 🔍 Query\n\n## Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| `slugOrId` | `String!` | Slug or ID of Tag |\n| `shouldIncludeInvisible` | `Boolean` | Set to true if you want to include tags that have isVisible set to false (default: `false`) |\n\n## Returns\n\n`Tag`\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tag\": {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"heroMedia\": {},\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"metafields\": [\n {\n \"description\": \"Example_String\",\n \"key\": \"Example_String\",\n \"namespace\": \"Example_String\",\n \"scope\": \"Example_String\",\n \"value\": 99.99,\n \"valueType\": \"Example_String\"\n }\n ],\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"shop\": {\n \"_id\": \"Example_ID\",\n \"description\": \"Example_String\",\n \"isCompany\": true,\n \"keywords\": \"Example_String\",\n \"name\": \"Example_String\",\n \"slug\": \"Example_String\",\n \"storeTemplateUrl\": \"https://exemplo.com\",\n \"acceptsBoleto\": true,\n \"acceptsCreditCard\": true,\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"domains\": [\n \"Example_String\"\n ],\n \"trialRemainingDays\": 10,\n \"sitemap\": \"Example_String\"\n },\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\",\n \"subTags\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n }\n}"},{"id":"adbd95e1-6d9a-41e8-9df8-4d61fde3e564","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tag($slugOrId: String!, $shouldIncludeInvisible: Boolean) {\n tag(slugOrId: $slugOrId, shouldIncludeInvisible: $shouldIncludeInvisible) {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n currency {\n _id\n code\n decimal\n format\n rate\n scale\n symbol\n thousand\n }\n firstName\n language\n lastName\n metafields {\n receiveNewOrderEmail\n }\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n totalAmount {\n amount\n displayAmount\n }\n constraints {\n buyerTypes\n usageLimit\n expirationDate\n }\n status\n isSoldOut\n isExpired\n shipping {\n fulfillmentType\n }\n description\n items {\n _id\n title\n description\n quantity\n productERPCode\n variantERPCode\n }\n ordersCount\n metadata {\n successCallbackURL\n }\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n discountedAmount {\n amount\n displayAmount\n }\n }\n email\n fulfillmentGroups {\n _id\n address {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n shippingLabel {\n url\n content\n }\n status\n totalItemQuantity\n trackingCode\n tracking {\n code\n url\n }\n type\n taxSummary {\n calculatedAt\n calculatedByTaxServiceName\n referenceId\n }\n }\n notes {\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n amount {\n amount\n displayAmount\n }\n billingAddress {\n _id\n alias\n address1\n address2\n city\n cityCode\n company\n country\n firstName\n fullName\n isBillingDefault\n isCommercial\n isShippingDefault\n lastName\n neighborhood\n number\n phone\n postal\n region\n reference\n taxPayerId\n mobile\n trackByMobile\n }\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n method {\n canRefund\n displayName\n isEnabled\n name\n pluginName\n }\n mode\n processor\n riskLevel\n status {\n status\n createdAt\n createdBy\n triggeredBy\n }\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shipping {\n invoice {\n url\n status\n }\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n summary {\n discountTotal {\n amount\n displayAmount\n }\n totalSavings {\n amount\n displayAmount\n }\n effectiveTaxRate {\n amount\n displayPercent\n percent\n }\n fulfillmentTotal {\n amount\n displayAmount\n }\n installmentAmount {\n amount\n displayAmount\n }\n interest {\n amount\n displayAmount\n }\n totalBeforeInterest {\n amount\n displayAmount\n }\n itemTotal {\n amount\n displayAmount\n }\n taxTotal {\n amount\n displayAmount\n }\n taxableAmount {\n amount\n displayAmount\n }\n total {\n amount\n displayAmount\n }\n totalWithoutDiscounts {\n amount\n displayAmount\n }\n totalWithoutAnySavings {\n amount\n displayAmount\n }\n surchargeTotal {\n amount\n displayAmount\n }\n }\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n amount {\n amount\n displayAmount\n }\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n favicon {\n smallImage {\n url\n altText\n }\n largeImage {\n url\n altText\n }\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n items {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n itemsMobile {\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n image {\n url\n altText\n }\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n termsAndConditions {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n aboutUs {\n enabled\n SEO {\n title\n description\n }\n components {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n pricing {\n displayPrice\n maxPrice\n minPrice\n price\n }\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n inventory {\n _id\n canBackorder\n inventoryInStock\n inventoryReserved\n isEnabled\n lowInventoryWarningThreshold\n }\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n media {\n _id\n priority\n productId\n variantId\n }\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n chargeAttemptsPipeline {\n attempts {\n onFailure {\n nextAttemptInMinutes\n }\n }\n onSuccess {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n onFailure {\n emails {\n emailTemplate\n sendToRecurringOrderCustomer\n sendToShopOwner\n sendTo\n }\n }\n }\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n postalRange {\n postalCodeFrom\n postalCodeTo\n }\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n}","variables":"{\n \"slugOrId\": \"Example_String\",\n \"shouldIncludeInvisible\": true\n}"}},"url":"{{base_url}}","description":"Returns a tag from a provided tag ID or slug. Tags with isVisible set to false are excluded by default.\n\n**Type:** 🔍 Query\n\n## Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| `slugOrId` | `String!` | Slug or ID of Tag |\n| `shouldIncludeInvisible` | `Boolean` | Set to true if you want to include tags that have isVisible set to false (default: `false`) |\n\n## Returns\n\n`Tag`\n"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"4ed6a284-6a82-524c-b441-1575db08cb41"},{"name":"[Query] tags","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns tags data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"tags\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"tags returns valid Connection structure\", function() {"," const json = pm.response.json();"," const data = json.data.tags;"," "," if (data !== null) {"," // Verificar pageInfo"," pm.expect(data).to.have.property(\"pageInfo\");"," pm.expect(data.pageInfo).to.have.property(\"hasNextPage\");"," pm.expect(data.pageInfo).to.have.property(\"hasPreviousPage\");"," "," // Verificar edges ou nodes"," if (data.edges !== undefined) {"," pm.expect(data.edges).to.be.an(\"array\");"," }"," if (data.nodes !== undefined) {"," pm.expect(data.nodes).to.be.an(\"array\");"," }"," }","});"]}}],"id":"bae2dc61-1e8d-5080-b91b-62db197524cb","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tags($filter: String, $excludedTagIds: [ID], $isTopLevel: Boolean, $shouldIncludeDeleted: Boolean, $shouldIncludeInvisible: Boolean, $after: String, $before: String, $first: Int, $last: Int, $sortOrder: SortOrder, $sortBy: TagSortByField) {\n tags(filter: $filter, excludedTagIds: $excludedTagIds, isTopLevel: $isTopLevel, shouldIncludeDeleted: $shouldIncludeDeleted, shouldIncludeInvisible: $shouldIncludeInvisible, after: $after, before: $before, first: $first, last: $last, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n nodes {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filter\": \"Example_String\",\n \"excludedTagIds\": [\n \"Example_ID\"\n ],\n \"isTopLevel\": true,\n \"shouldIncludeDeleted\": true,\n \"shouldIncludeInvisible\": true,\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"\nPropósito: Retorna uma lista paginada (Relay) das tags da sua loja, com filtros por hierarquia, visibilidade, exclusão lógica e busca textual.\nQuando usar: Para descobrir/enumerar tags sem conhecer o identificador de antemão — por exemplo, listar as tags de nível raiz (isTopLevel: true) para montar um menu principal, ou buscar por nome/slug parcial com filter. Para buscar uma tag específica já conhecida, prefira tag (mais direto).\nAutenticação: x-api-key + Authorization (token de signIn). O shopId é injetado a partir do seu token — não envie.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\nfilter | \nString | \nNão | \n— | \nBusca por substring (case-insensitive) em name e slug simultaneamente. Não é regex livre: caracteres especiais de regex (., *, ^, etc.) enviados em filter são tratados como texto literal, não como wildcard. | \n
\n\nexcludedTagIds | \n[ID] | \nNão | \n— | \nIDs de tags a excluir do resultado. | \n
\n\nisTopLevel | \nBoolean | \nNão | \n— | \nSe enviado, filtra apenas tags de nível raiz (true) ou apenas tags que não são de nível raiz (false). Se omitido, retorna ambos os tipos. | \n
\n\nshouldIncludeDeleted | \nBoolean | \nNão | \nfalse | \nSe true, inclui tags com isDeleted: true no resultado. | \n
\n\nshouldIncludeInvisible | \nBoolean | \nNão | \nfalse | \nSe true, inclui tags com isVisible: false no resultado. | \n
\n\nafter | \nString | \nNão | \n— | \nCursor: retorna apenas resultados após este cursor. Use com first. | \n
\n\nbefore | \nString | \nNão | \n— | \nCursor: retorna apenas resultados antes deste cursor. Use com last. | \n
\n\nfirst | \nInt | \nNão | \n— | \nQuantidade máxima de resultados, a partir do início (ou de after). Não combine com last. | \n
\n\nlast | \nInt | \nNão | \n— | \nQuantidade máxima de resultados, a partir do fim (ou antes de before). Não combine com first. | \n
\n\nsortOrder | \nSortOrder (asc/desc) | \nNão | \nasc | \nDireção da ordenação. | \n
\n\nsortBy | \nTagSortByField | \nNão | \nposition | \nCampo de ordenação (_id, createdAt, name, position, updatedAt). | \n
\n\n
\n
Retorno
\nTagConnection — connection Relay cujos nodes/edges.node seguem exatamente os mesmos campos de Tag documentados na operação tag (_id, name, slug, displayTitle, isTopLevel, isVisible, isDeleted, subTagIds, position, etc.).
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\nnodes | \n[Tag] | \nAtalho com os itens da página atual, sem o wrapper de cursor. | \n
\n\nedges | \n[TagEdge] | \nItens da página com cursor individual. | \n
\n\nedges[].cursor | \nString! | \nCursor daquele item — use em after/before de chamadas seguintes. | \n
\n\nedges[].node | \nTag | \nO objeto tag (mesmos campos documentados em tag). | \n
\n\npageInfo | \nPageInfo! | \nMetadados de paginação. | \n
\n\npageInfo.hasNextPage | \nBoolean! | \nSe há mais resultados após esta página. | \n
\n\npageInfo.hasPreviousPage | \nBoolean! | \nSe há resultados antes desta página. | \n
\n\npageInfo.startCursor | \nString | \nCursor do primeiro item da página. | \n
\n\npageInfo.endCursor | \nString | \nCursor do último item da página. | \n
\n\ntotalCount | \nInt! | \nTotal de tags que correspondem aos filtros, ignorando a paginação. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\nFORBIDDEN_ERROR | \naccess_token ausente, inválido ou expirado. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nfirst e last enviados na mesma chamada. | \nEnvie apenas um dos dois — first/after para avançar, last/before para retroceder. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio. O conflito first+last chega como um erro de validação com mensagem descritiva, sem extensions.code estável — identifique-o por errors[].message.
\n
\nNotas
\n\n- Sem argumento para \"filhas de uma tag\". Não há um filtro tipo
parentTagId. Para montar a árvore de hierarquia, use subTagIds da tag pai (obtida via tag ou dentro de nodes desta query) e busque cada filha com tag(slugOrId: <id>), ou traga todas as tags de uma vez e cruze _id com subTagIds do seu lado. \n- Página padrão de 20 itens. Se nem
first nem last forem enviados, a resposta é limitada a 20 resultados. \n- Ordenação padrão por
position, não por data. Se você espera ordem cronológica, envie sortBy: createdAt (ou updatedAt) explicitamente. \nshouldIncludeDeleted e shouldIncludeInvisible são independentes — para trazer o catálogo completo de tags (incluindo excluídas e invisíveis), envie ambos como true.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3b89c2ac-6239-4eda-9f1a-f7123b98d36f","name":"200 - tags","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tags($filter: String, $excludedTagIds: [ID], $isTopLevel: Boolean, $shouldIncludeDeleted: Boolean, $shouldIncludeInvisible: Boolean, $after: String, $before: String, $first: Int, $last: Int, $sortOrder: SortOrder, $sortBy: TagSortByField) {\n tags(filter: $filter, excludedTagIds: $excludedTagIds, isTopLevel: $isTopLevel, shouldIncludeDeleted: $shouldIncludeDeleted, shouldIncludeInvisible: $shouldIncludeInvisible, after: $after, before: $before, first: $first, last: $last, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n nodes {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filter\": \"Example_String\",\n \"excludedTagIds\": [\n \"Example_ID\"\n ],\n \"isTopLevel\": true,\n \"shouldIncludeDeleted\": true,\n \"shouldIncludeInvisible\": true,\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## tags\n\n**Propósito:** Retorna uma lista paginada (Relay) das tags da sua loja, com filtros por hierarquia, visibilidade, exclusão lógica e busca textual.\n**Quando usar:** Para descobrir/enumerar tags sem conhecer o identificador de antemão — por exemplo, listar as tags de nível raiz (`isTopLevel: true`) para montar um menu principal, ou buscar por nome/slug parcial com `filter`. Para buscar uma tag específica já conhecida, prefira `tag` (mais direto).\n**Autenticação:** `x-api-key` + `Authorization` (token de `signIn`). O `shopId` é injetado a partir do seu token — não envie.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------------------------- | ----------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `filter` | `String` | Não | — | Busca por substring (case-insensitive) em `name` e `slug` simultaneamente. Não é regex livre: caracteres especiais de regex (`.`, `*`, `^`, etc.) enviados em `filter` são tratados como texto literal, não como wildcard. |\n| `excludedTagIds` | `[ID]` | Não | — | IDs de tags a excluir do resultado. |\n| `isTopLevel` | `Boolean` | Não | — | Se enviado, filtra apenas tags de nível raiz (`true`) ou apenas tags que não são de nível raiz (`false`). Se omitido, retorna ambos os tipos. |\n| `shouldIncludeDeleted` | `Boolean` | Não | `false` | Se `true`, inclui tags com `isDeleted: true` no resultado. |\n| `shouldIncludeInvisible` | `Boolean` | Não | `false` | Se `true`, inclui tags com `isVisible: false` no resultado. |\n| `after` | `String` | Não | — | Cursor: retorna apenas resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor: retorna apenas resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados, a partir do início (ou de `after`). Não combine com `last`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados, a partir do fim (ou antes de `before`). Não combine com `first`. |\n| `sortOrder` | `SortOrder` (`asc`/`desc`) | Não | `asc` | Direção da ordenação. |\n| `sortBy` | `TagSortByField` | Não | `position` | Campo de ordenação (`_id`, `createdAt`, `name`, `position`, `updatedAt`). |\n\n### Retorno\n\n`TagConnection` — connection Relay cujos `nodes`/`edges.node` seguem exatamente os mesmos campos de `Tag` documentados na operação `tag` (`_id`, `name`, `slug`, `displayTitle`, `isTopLevel`, `isVisible`, `isDeleted`, `subTagIds`, `position`, etc.).\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------- | -------------------------------------------------------------------- |\n| `nodes` | `[Tag]` | Atalho com os itens da página atual, sem o wrapper de cursor. |\n| `edges` | `[TagEdge]` | Itens da página com cursor individual. |\n| `edges[].cursor` | `String!` | Cursor daquele item — use em `after`/`before` de chamadas seguintes. |\n| `edges[].node` | `Tag` | O objeto tag (mesmos campos documentados em `tag`). |\n| `pageInfo` | `PageInfo!` | Metadados de paginação. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após esta página. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes desta página. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página. |\n| `totalCount` | `Int!` | Total de tags que correspondem aos filtros, ignorando a paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | `first` e `last` enviados na mesma chamada. | Envie apenas um dos dois — `first`/`after` para avançar, `last`/`before` para retroceder. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. O conflito `first`+`last` chega como um erro de validação com mensagem descritiva, sem `extensions.code` estável — identifique-o por `errors[].message`.\n\n### Notas\n\n- **Sem argumento para \"filhas de uma tag\".** Não há um filtro tipo `parentTagId`. Para montar a árvore de hierarquia, use `subTagIds` da tag pai (obtida via `tag` ou dentro de `nodes` desta query) e busque cada filha com `tag(slugOrId: )`, ou traga todas as tags de uma vez e cruze `_id` com `subTagIds` do seu lado.\n- **Página padrão de 20 itens.** Se nem `first` nem `last` forem enviados, a resposta é limitada a 20 resultados.\n- **Ordenação padrão por `position`, não por data.** Se você espera ordem cronológica, envie `sortBy: createdAt` (ou `updatedAt`) explicitamente.\n- **`shouldIncludeDeleted` e `shouldIncludeInvisible` são independentes** — para trazer o catálogo completo de tags (incluindo excluídas e invisíveis), envie ambos como `true`."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"tags\": {\n \"nodes\": [\n {\n \"_id\": \"Example_ID\",\n \"erpCode\": \"Example_String\",\n \"createdAt\": \"2025-01-15T10:00:00Z\",\n \"displayTitle\": \"Example_String\",\n \"description\": \"Example_String\",\n \"featuredProductIds\": [\n \"Example_ID\"\n ],\n \"isDeleted\": true,\n \"isTopLevel\": true,\n \"isVisible\": true,\n \"name\": \"Example_String\",\n \"position\": 10,\n \"publishedUrl\": \"https://exemplo.com\",\n \"slug\": \"Example_String\",\n \"subTagIds\": [\n \"Example_ID\"\n ],\n \"updatedAt\": \"2025-01-15T10:00:00Z\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": null\n },\n \"totalCount\": 10\n }\n }\n}"},{"id":"e22e7149-e992-4343-a7d7-8292ef853f36","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Tags($filter: String, $excludedTagIds: [ID], $isTopLevel: Boolean, $shouldIncludeDeleted: Boolean, $shouldIncludeInvisible: Boolean, $after: String, $before: String, $first: Int, $last: Int, $sortOrder: SortOrder, $sortBy: TagSortByField) {\n tags(filter: $filter, excludedTagIds: $excludedTagIds, isTopLevel: $isTopLevel, shouldIncludeDeleted: $shouldIncludeDeleted, shouldIncludeInvisible: $shouldIncludeInvisible, after: $after, before: $before, first: $first, last: $last, sortOrder: $sortOrder, sortBy: $sortBy) {\n edges {\n cursor\n node {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n cartId\n createdAt\n email\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n primaryColor\n showProductInstallments\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n }\n nodes {\n _id\n erpCode\n createdAt\n displayTitle\n description\n featuredProductIds\n heroMedia {\n desktop {\n url\n altText\n }\n mobile {\n url\n altText\n }\n }\n isDeleted\n isTopLevel\n isVisible\n metafields {\n description\n key\n namespace\n scope\n value\n valueType\n }\n name\n position\n publishedUrl\n shop {\n shopSales {\n _id\n code\n conditions {\n accountLimit\n redemptionLimit\n recurrenceCycleLimit\n startDate\n endDate\n max\n min\n productType\n tags\n audience\n permissions\n products\n }\n description\n discountMethod\n label\n transactions {\n _id\n account {\n _id\n addressBook {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n }\n }\n }\n bio\n createdAt\n firstName\n language\n lastName\n name\n note\n picture\n preferences\n primaryEmailAddress\n updatedAt\n userId\n username\n externalAccountId\n isFirstAccess\n groups {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n cartId\n paymentLink {\n _id\n referenceId\n type\n shopId\n externalId\n createdAt\n updatedAt\n title\n createdBy\n updatedBy\n status\n isSoldOut\n isExpired\n description\n ordersCount\n paymentMethod\n blockPaymentMethodChange\n blockApplyDiscountCode\n blockApplyShopSale\n }\n createdAt\n discounts {\n code\n description\n discount\n discountMethod\n label\n }\n email\n fulfillmentGroups {\n _id\n items {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n title\n }\n }\n }\n status\n totalItemQuantity\n trackingCode\n type\n }\n notes {\n content\n createdAt\n updatedAt\n }\n payments {\n _id\n captureErrorCode\n captureErrorMessage\n cardBrand\n createdAt\n displayName\n isAuthorizationCanceled\n isCaptured\n mode\n processor\n riskLevel\n tookLossOnSale\n transactionId\n threeDSChallengeRequested\n threeDSChallengePayload\n }\n shopSales {\n _id\n amount\n createdAt\n currencyCode\n data\n displayName\n method\n mode\n name\n paymentPluginName\n processor\n status\n transactionId\n }\n recurringOrderId\n recurringOrderCycleId\n generatedNewRecurringOrder\n recurringOrderFrequencyId\n referenceId\n source\n status\n totalItemQuantity\n updatedAt\n invoiceIssued\n sentToERP\n soldToCompany\n sentToLP\n dispatched\n delivered\n problemDelivering\n isBoletoPaid\n shippingLabelPending\n shippingLabelFailed\n surcharges {\n _id\n fulfillmentGroupId\n surchargeDefinitionId\n }\n }\n enabled\n createdAt\n updatedAt\n }\n _id\n brandAssets {\n navbarBrandImage {\n large\n medium\n original\n small\n thumbnail\n }\n navbarBrandImageId\n }\n defaultParcelSize {\n height\n length\n weight\n width\n }\n description\n isCompany\n storefrontTemplate {\n _id\n shopId\n createdAt\n updatedAt\n general {\n logo {\n url\n altText\n }\n primaryColor\n buyButton {\n backgroundColor\n fontColor\n hoverColor\n }\n SEO {\n keywords\n gaId\n pixelId\n gtmId\n title\n description\n }\n showProductInstallments\n }\n header {\n headerText {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n menuItems {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n }\n footer {\n backgroundColor\n fontColor\n footerDescription\n aboutUs {\n _id\n type\n maxItems\n enabled\n readOnly\n title\n subtitle\n description\n localPath\n externalUrl\n backgroundColor\n fontColor\n metadata\n }\n social {\n instagram\n facebook\n youtube\n pinterest\n twitter\n linkedin\n whatsapp\n }\n contactUs {\n firstLine\n secondLine\n thirdLine\n }\n }\n pages {\n home {\n enabled\n }\n termsAndConditions {\n enabled\n }\n aboutUs {\n enabled\n }\n }\n }\n keywords\n name\n recurringOrdersPolicy {\n _id\n shopId\n enabled\n createdAt\n updatedAt\n allowedFrequencies {\n _id\n title\n periodicity\n interval\n }\n minDaysIntervalBetweenCycles\n pricingPolicy {\n type\n value\n }\n keepOrderPricingPolicy\n productsPolicy {\n includeAllProducts\n products {\n compareAtPrice\n price\n _id\n erpCode\n attributeLabel\n barcode\n createdAt\n height\n index\n isDeleted\n isVisible\n imageUrls\n videoUrls\n length\n minOrderQuantity\n maxOrderQuantity\n optionTitle\n originCountry\n sku\n title\n updatedAt\n weight\n width\n isTaxable\n taxCode\n taxDescription\n }\n }\n termsAndConditions\n customerActions {\n canSkipCycle\n canChangeFrequency\n canPause\n canChangeAddress\n canAddProducts\n canRemoveProducts\n canChangeProductQuantity\n }\n }\n shopLogoUrls {\n primaryShopLogoUrl\n }\n social {\n instagramUrl\n facebookUrl\n }\n slug\n storefrontUrls {\n storefrontAccountProfileUrl\n storefrontHomeUrl\n storefrontLoginUrl\n storefrontOrderUrl\n storefrontOrdersUrl\n }\n storeTemplateUrl\n providers {\n logistics\n payment\n products\n checkout\n invoice\n erp\n marketing\n }\n acceptsBoleto\n acceptsCreditCard\n createdAt\n domains\n trialRemainingDays\n fulfillmentOptions {\n _id\n name\n description\n label\n carrier\n enabled\n classification\n type\n shopId\n handling {\n value\n isPercentage\n }\n constraints {\n weight {\n min\n max\n }\n cubeWeight {\n min\n max\n }\n length {\n min\n max\n }\n height {\n min\n max\n }\n width {\n min\n max\n }\n subtotal {\n min\n max\n }\n dimensionsSum {\n min\n max\n }\n postalCoverage {\n locationId\n name\n state\n region\n type\n }\n postalOutOfCoverage {\n locationId\n name\n state\n region\n type\n }\n }\n address {\n address1\n address2\n city\n cityCode\n country\n fullName\n neighborhood\n number\n postal\n region\n }\n additionalDaysToDeliver\n availability {\n days\n startHour\n endHour\n }\n createdAt\n updatedAt\n ordersCount\n missingCredentials\n }\n settings {\n allowLegalPersonSales\n showOutOfStockCatalogs\n allowAnonymousRecurringOrders\n maxInstallments\n threeDSActive\n shopify {\n storeDomain\n }\n unboxPayProviders\n }\n dashboards {\n url\n title\n header\n category\n }\n sitemap\n tags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n slug\n subTagIds\n updatedAt\n subTags {\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n totalCount\n edges {\n cursor\n node {\n _id\n name\n slug\n }\n }\n }\n }\n pageInfo {\n endCursor\n hasNextPage\n hasPreviousPage\n startCursor\n }\n totalCount\n }\n}","variables":"{\n \"filter\": \"Example_String\",\n \"excludedTagIds\": [\n \"Example_ID\"\n ],\n \"isTopLevel\": true,\n \"shouldIncludeDeleted\": true,\n \"shouldIncludeInvisible\": true,\n \"after\": \"eyJvZmZzZXQiOjB9\",\n \"before\": \"eyJvZmZzZXQiOjB9\",\n \"first\": 20,\n \"last\": 20,\n \"sortOrder\": \"asc\",\n \"sortBy\": \"_id\"\n}"}},"url":"{{base_url}}","description":"## tags\n\n**Propósito:** Retorna uma lista paginada (Relay) das tags da sua loja, com filtros por hierarquia, visibilidade, exclusão lógica e busca textual.\n**Quando usar:** Para descobrir/enumerar tags sem conhecer o identificador de antemão — por exemplo, listar as tags de nível raiz (`isTopLevel: true`) para montar um menu principal, ou buscar por nome/slug parcial com `filter`. Para buscar uma tag específica já conhecida, prefira `tag` (mais direto).\n**Autenticação:** `x-api-key` + `Authorization` (token de `signIn`). O `shopId` é injetado a partir do seu token — não envie.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------------------------- | ----------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `filter` | `String` | Não | — | Busca por substring (case-insensitive) em `name` e `slug` simultaneamente. Não é regex livre: caracteres especiais de regex (`.`, `*`, `^`, etc.) enviados em `filter` são tratados como texto literal, não como wildcard. |\n| `excludedTagIds` | `[ID]` | Não | — | IDs de tags a excluir do resultado. |\n| `isTopLevel` | `Boolean` | Não | — | Se enviado, filtra apenas tags de nível raiz (`true`) ou apenas tags que não são de nível raiz (`false`). Se omitido, retorna ambos os tipos. |\n| `shouldIncludeDeleted` | `Boolean` | Não | `false` | Se `true`, inclui tags com `isDeleted: true` no resultado. |\n| `shouldIncludeInvisible` | `Boolean` | Não | `false` | Se `true`, inclui tags com `isVisible: false` no resultado. |\n| `after` | `String` | Não | — | Cursor: retorna apenas resultados após este cursor. Use com `first`. |\n| `before` | `String` | Não | — | Cursor: retorna apenas resultados antes deste cursor. Use com `last`. |\n| `first` | `Int` | Não | — | Quantidade máxima de resultados, a partir do início (ou de `after`). Não combine com `last`. |\n| `last` | `Int` | Não | — | Quantidade máxima de resultados, a partir do fim (ou antes de `before`). Não combine com `first`. |\n| `sortOrder` | `SortOrder` (`asc`/`desc`) | Não | `asc` | Direção da ordenação. |\n| `sortBy` | `TagSortByField` | Não | `position` | Campo de ordenação (`_id`, `createdAt`, `name`, `position`, `updatedAt`). |\n\n### Retorno\n\n`TagConnection` — connection Relay cujos `nodes`/`edges.node` seguem exatamente os mesmos campos de `Tag` documentados na operação `tag` (`_id`, `name`, `slug`, `displayTitle`, `isTopLevel`, `isVisible`, `isDeleted`, `subTagIds`, `position`, etc.).\n\n| Propriedade | Tipo | Descrição |\n| -------------------------- | ----------- | -------------------------------------------------------------------- |\n| `nodes` | `[Tag]` | Atalho com os itens da página atual, sem o wrapper de cursor. |\n| `edges` | `[TagEdge]` | Itens da página com cursor individual. |\n| `edges[].cursor` | `String!` | Cursor daquele item — use em `after`/`before` de chamadas seguintes. |\n| `edges[].node` | `Tag` | O objeto tag (mesmos campos documentados em `tag`). |\n| `pageInfo` | `PageInfo!` | Metadados de paginação. |\n| `pageInfo.hasNextPage` | `Boolean!` | Se há mais resultados após esta página. |\n| `pageInfo.hasPreviousPage` | `Boolean!` | Se há resultados antes desta página. |\n| `pageInfo.startCursor` | `String` | Cursor do primeiro item da página. |\n| `pageInfo.endCursor` | `String` | Cursor do último item da página. |\n| `totalCount` | `Int!` | Total de tags que correspondem aos filtros, ignorando a paginação. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ----------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| `FORBIDDEN_ERROR` | `access_token` ausente, inválido ou expirado. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | `first` e `last` enviados na mesma chamada. | Envie apenas um dos dois — `first`/`after` para avançar, `last`/`before` para retroceder. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio. O conflito `first`+`last` chega como um erro de validação com mensagem descritiva, sem `extensions.code` estável — identifique-o por `errors[].message`.\n\n### Notas\n\n- **Sem argumento para \"filhas de uma tag\".** Não há um filtro tipo `parentTagId`. Para montar a árvore de hierarquia, use `subTagIds` da tag pai (obtida via `tag` ou dentro de `nodes` desta query) e busque cada filha com `tag(slugOrId: )`, ou traga todas as tags de uma vez e cruze `_id` com `subTagIds` do seu lado.\n- **Página padrão de 20 itens.** Se nem `first` nem `last` forem enviados, a resposta é limitada a 20 resultados.\n- **Ordenação padrão por `position`, não por data.** Se você espera ordem cronológica, envie `sortBy: createdAt` (ou `updatedAt`) explicitamente.\n- **`shouldIncludeDeleted` e `shouldIncludeInvisible` são independentes** — para trazer o catálogo completo de tags (incluindo excluídas e invisíveis), envie ambos como `true`."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"bae2dc61-1e8d-5080-b91b-62db197524cb"}],"id":"1a0461d5-a9f7-45ef-930c-fec5742e57c8","_postman_id":"1a0461d5-a9f7-45ef-930c-fec5742e57c8","description":""}],"id":"1ccaa475-16e9-4720-8bad-734dc000b26d","description":"\nConsultas somente-leitura para as tags (categorias) do seu catálogo. Uma tag organiza produtos em um agrupamento temático — usado tipicamente para montar páginas de navegação, vitrines por categoria e páginas de listagem de produtos. tag busca uma tag específica por ID ou slug; tags lista/filtra as tags da loja com paginação Relay.
\nConceitos
\n\n- Hierarquia. Tags podem ter \"tags filhas\" (subtags), formando uma árvore de até três níveis: raiz → filhas → netas (não há um quarto nível).
isTopLevel: true marca uma tag como pertencente ao nível raiz. subTagIds é a lista ordenada dos IDs das tags filhas diretas de uma tag — é assim que você desce um nível na hierarquia. \n- Sem operação dedicada para \"listar filhas\". Não existe um argumento tipo
parentTagId em tags. Para montar a árvore, busque a tag pai (por tag ou dentro dos nodes de tags), leia seu subTagIds, e busque cada filha individualmente via tag(slugOrId: <id>) — ou traga todas as tags de uma vez com tags e monte a árvore do seu lado cruzando _id com subTagIds. \n- Ordem entre tags irmãs.
position define a ordem de exibição de uma tag em relação às outras do mesmo nível da hierarquia — é também o critério de ordenação padrão de tags. \n- Visibilidade (
isVisible) e exclusão lógica (isDeleted). Uma tag com isVisible: false não deveria ser exibida publicamente (ex.: página de categoria ainda não publicada). Uma tag com isDeleted: true foi excluída (soft-delete). Por padrão, tags invisíveis e excluídas ficam de fora dos resultados — cada operação documenta como habilitar cada inclusão (ver páginas de tag/tags). \n
\nTipos e enums compartilhados
\n\n\n\n| Enum/Tipo | \nValores | \nDescrição | \n
\n\n\n\nTagSortByField | \n_id, createdAt, name, position, updatedAt | \nCampo de ordenação usado por tags. Se omitido, a ordenação padrão é por position. | \n
\n\n
\n
Regras de negócio
\n\nshopId injetado na borda. Nem tag nem tags recebem shopId como argumento — ele é derivado automaticamente do seu access_token no momento da chamada. Basta autenticar com Authorization válido.- Paginação Relay em
tags. Retorna uma connection com edges ({ cursor, node }), nodes (atalho sem o wrapper de cursor), pageInfo (hasNextPage, hasPreviousPage, startCursor, endCursor) e totalCount. Use first + after: <pageInfo.endCursor> para avançar, ou last + before: <pageInfo.startCursor> para retroceder — não envie first e last na mesma chamada. Se nenhum dos dois for enviado, a página retornada é limitada a 20 resultados. \nfilter de tags é busca por substring (case-insensitive), aplicada simultaneamente a name e slug — não é regex livre: caracteres especiais de regex enviados em filter são tratados como texto literal, não como wildcard.- Escopo por loja. As duas operações só enxergam tags da sua própria loja (autenticada via token); não há forma de consultar tags de outra loja.
\n
\n","_postman_id":"1ccaa475-16e9-4720-8bad-734dc000b26d"},{"name":"Unbox Pay","item":[{"name":"Query","item":[{"name":"[Query] getInstallments","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns getInstallments data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"getInstallments\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});","","pm.test(\"getInstallments returns valid structure\", function() {"," const json = pm.response.json();"," const data = json.data.getInstallments;"," "," if (data !== null) {"," if (data.installments !== undefined && data.installments !== null) {"," pm.expect(data.installments).to.be.an(\"array\");"," }"," }","});"]}}],"id":"27706560-f705-5730-aef1-414565c2325a","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query GetInstallments($input: GetInstallmentsInput!) {\n getInstallments(input: $input) {\n installments {\n installment\n amount\n currency\n symbol\n amountWithoutInterest\n interestRatePercentage\n installmentInterest\n totalInterest\n totalBeforeInterest\n total\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"amount\": 99.99\n }\n}"}},"url":"{{base_url}}","description":"getInstallments
\nPropósito: Simula as opções de parcelamento disponíveis para um valor de compra, na loja autenticada.\nQuando usar: Chame antes de fechar um pedido (ex.: junto do createExternalCheckout) para exibir ao comprador quantas parcelas ele pode escolher e o valor de cada uma, incluindo juros quando a loja os aplica. Não reserva nem altera nada — é apenas um cálculo, pode ser chamado quantas vezes forem necessárias.\nAutenticação: x-api-key + Authorization. A loja é derivada automaticamente do seu token — não envie shopId, esse argumento não existe nesta operação.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.amount | \nFloat! | \nSim | \n— | \nValor total da compra, em unidades decimais da moeda da loja (ex.: 149.90 para R$ 149,90 — não envie em centavos). A API calcula as opções de parcelamento com base nesse valor. | \n
\n\ninput.clientMutationId | \nString | \nNão | \nnull | \nIdentificador livre de correlação da sua chamada. Não é usado no cálculo e não volta na resposta desta operação — envie apenas se for útil para seu próprio rastreamento de requisições. | \n
\n\n
\n
Não há validação explícita de input.amount: enviar 0 ou um valor negativo não retorna um erro de validação — apenas produz parcelas com valores sem sentido de negócio. Garanta que o valor enviado seja sempre positivo e condizente com o total real da compra.
\nRetorno
\nGetInstallmentsResponse: um único campo, installments, com a lista completa de opções de parcelamento — uma entrada por número de parcelas, de 1 até o máximo configurado para a loja. Não é possível pedir apenas uma quantidade específica.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\ninstallments | \n[ShopInstallment]! | \nLista de opções, uma por número de parcelas. | \n
\n\ninstallments[].installment | \nInt! | \nNúmero de parcelas desta opção (1, 2, 3...). | \n
\n\ninstallments[].amount | \nFloat! | \nValor de cada parcela para esse número de parcelas, já incluindo juros quando a loja os aplica. | \n
\n\ninstallments[].currency | \nString! | \nCódigo da moeda da loja (ex.: BRL). | \n
\n\ninstallments[].symbol | \nString! | \nSímbolo da moeda (ex.: R$). | \n
\n\ninstallments[].amountWithoutInterest | \nFloat | \nValor da parcela sem juros. Vem preenchido só quando a loja aplica juros para esse número de parcelas; caso contrário é null. | \n
\n\ninstallments[].interestRatePercentage | \nFloat | \nPercentual de juros aplicado uma única vez sobre o valor total da compra (input.amount) para essa opção — não é uma taxa mensal nem composta por parcela. null quando não há juros nessa faixa de parcelas. | \n
\n\ninstallments[].installmentInterest | \nFloat | \nFração dos juros embutida em cada parcela: totalInterest dividido pelo número de parcelas dessa opção. null quando não há juros nessa faixa. | \n
\n\ninstallments[].totalInterest | \nFloat | \nTotal de juros cobrado sobre a compra inteira para esse número de parcelas (0 quando não há juros). | \n
\n\ninstallments[].totalBeforeInterest | \nFloat | \nO valor original enviado em input.amount, repetido em cada opção para referência. | \n
\n\ninstallments[].total | \nFloat | \nValor total a pagar para esse número de parcelas (input.amount + totalInterest daquela faixa). | \n
\n\n
\n
Cuidado com arredondamento: amount, total e os demais valores são arredondados independentemente para duas casas decimais. amount × installment pode divergir de total em poucos centavos (ex.: 7 parcelas de 20.57 somam 143.99, mas total pode ser 144.00). Use sempre total/totalInterest como valores autoritativos — não os recalcule a partir de amount.
\nExemplo
\nIlustração (valores de uma loja hipotética, apenas para explicar o formato — os limiares reais variam por loja): input.amount = 120, com juros configurados a partir da 2ª parcela (10%), da 6ª (20%) e da 10ª (30%):
\n\n\n\ninstallment | \namount | \namountWithoutInterest | \ninterestRatePercentage | \ninstallmentInterest | \ntotalInterest | \ntotal | \n
\n\n\n\n| 1 | \n120 | \nnull | \nnull | \nnull | \n0 | \n120 | \n
\n\n| 2 | \n66 | \n60 | \n10 | \n6 | \n12 | \n132 | \n
\n\n| 6 | \n24 | \n20 | \n20 | \n4 | \n24 | \n144 | \n
\n\n| 10 | \n15.6 | \n12 | \n30 | \n3.6 | \n36 | \n156 | \n
\n\n
\n
Note que total/totalInterest são iguais entre parcelas 2–5 (mesma faixa de 10%) e entre 6–9 (mesma faixa de 20%) — só amount muda, dividindo o mesmo total em mais parcelas.
\nErros
\nEsta operação não expõe hoje códigos estáveis de erro (extensions.code) — identifique o cenário pela mensagem em message.
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| (sem código) | \nAuthorization ausente, inválido ou expirado, impedindo a derivação da loja autenticada. | \nRefaça signIn e reenvie a chamada com um Authorization válido. | \n
\n\n| (sem código) | \nA loja autenticada não tem parcelamento (Unbox Pay) configurado. | \nContate seu representante Unbox para configurar as regras de parcelamento da loja antes de chamar esta operação. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha, mesmo para os cenários acima.
\n
\nNotas
\n\namountWithoutInterest, interestRatePercentage e installmentInterest só aparecem quando a loja aplica juros para aquele número específico de parcelas. Trate a ausência (null) como \"sem juros nesta opção\", não como dado faltando. Ver Exemplo acima para o formato completo.- Sem efeito colateral e idempotente: é apenas um cálculo, pode repetir a chamada livremente.
\ninput.amount deve ser sempre em formato decimal da moeda — nunca em centavos.
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a40f9a59-752c-4635-9f45-3149d8b8a187","name":"200 - getInstallments","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query GetInstallments($input: GetInstallmentsInput!) {\n getInstallments(input: $input) {\n installments {\n installment\n amount\n currency\n symbol\n amountWithoutInterest\n interestRatePercentage\n installmentInterest\n totalInterest\n totalBeforeInterest\n total\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"amount\": 99.99\n }\n}"}},"url":"{{base_url}}","description":"## getInstallments\n\n**Propósito:** Simula as opções de parcelamento disponíveis para um valor de compra, na loja autenticada.\n**Quando usar:** Chame antes de fechar um pedido (ex.: junto do `createExternalCheckout`) para exibir ao comprador quantas parcelas ele pode escolher e o valor de cada uma, incluindo juros quando a loja os aplica. Não reserva nem altera nada — é apenas um cálculo, pode ser chamado quantas vezes forem necessárias.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é derivada automaticamente do seu token — não envie `shopId`, esse argumento não existe nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------- | ----------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.amount` | `Float!` | Sim | — | Valor total da compra, em unidades decimais da moeda da loja (ex.: `149.90` para R$ 149,90 — **não** envie em centavos). A API calcula as opções de parcelamento com base nesse valor. |\n| `input.clientMutationId` | `String` | Não | `null` | Identificador livre de correlação da sua chamada. Não é usado no cálculo e não volta na resposta desta operação — envie apenas se for útil para seu próprio rastreamento de requisições. |\n\nNão há validação explícita de `input.amount`: enviar `0` ou um valor negativo não retorna um erro de validação — apenas produz parcelas com valores sem sentido de negócio. Garanta que o valor enviado seja sempre positivo e condizente com o total real da compra.\n\n### Retorno\n\n`GetInstallmentsResponse`: um único campo, `installments`, com a lista completa de opções de parcelamento — uma entrada por número de parcelas, de 1 até o máximo configurado para a loja. Não é possível pedir apenas uma quantidade específica.\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `installments` | `[ShopInstallment]!` | Lista de opções, uma por número de parcelas. |\n| `installments[].installment` | `Int!` | Número de parcelas desta opção (1, 2, 3...). |\n| `installments[].amount` | `Float!` | Valor de cada parcela para esse número de parcelas, já incluindo juros quando a loja os aplica. |\n| `installments[].currency` | `String!` | Código da moeda da loja (ex.: `BRL`). |\n| `installments[].symbol` | `String!` | Símbolo da moeda (ex.: `R$`). |\n| `installments[].amountWithoutInterest` | `Float` | Valor da parcela sem juros. Vem preenchido só quando a loja aplica juros para esse número de parcelas; caso contrário é `null`. |\n| `installments[].interestRatePercentage` | `Float` | Percentual de juros aplicado **uma única vez sobre o valor total da compra** (`input.amount`) para essa opção — não é uma taxa mensal nem composta por parcela. `null` quando não há juros nessa faixa de parcelas. |\n| `installments[].installmentInterest` | `Float` | Fração dos juros embutida em cada parcela: `totalInterest` dividido pelo número de parcelas dessa opção. `null` quando não há juros nessa faixa. |\n| `installments[].totalInterest` | `Float` | Total de juros cobrado sobre a compra inteira para esse número de parcelas (`0` quando não há juros). |\n| `installments[].totalBeforeInterest` | `Float` | O valor original enviado em `input.amount`, repetido em cada opção para referência. |\n| `installments[].total` | `Float` | Valor total a pagar para esse número de parcelas (`input.amount` + `totalInterest` daquela faixa). |\n\n**Cuidado com arredondamento:** `amount`, `total` e os demais valores são arredondados independentemente para duas casas decimais. `amount × installment` pode divergir de `total` em poucos centavos (ex.: 7 parcelas de `20.57` somam `143.99`, mas `total` pode ser `144.00`). Use sempre `total`/`totalInterest` como valores autoritativos — não os recalcule a partir de `amount`.\n\n### Exemplo\n\nIlustração (valores de uma loja hipotética, apenas para explicar o formato — os limiares reais variam por loja): `input.amount = 120`, com juros configurados a partir da 2ª parcela (10%), da 6ª (20%) e da 10ª (30%):\n\n| `installment` | `amount` | `amountWithoutInterest` | `interestRatePercentage` | `installmentInterest` | `totalInterest` | `total` |\n| ------------- | -------- | ----------------------- | ------------------------ | --------------------- | --------------- | ------- |\n| 1 | 120 | `null` | `null` | `null` | 0 | 120 |\n| 2 | 66 | 60 | 10 | 6 | 12 | 132 |\n| 6 | 24 | 20 | 20 | 4 | 24 | 144 |\n| 10 | 15.6 | 12 | 30 | 3.6 | 36 | 156 |\n\nNote que `total`/`totalInterest` são iguais entre parcelas 2–5 (mesma faixa de 10%) e entre 6–9 (mesma faixa de 20%) — só `amount` muda, dividindo o mesmo total em mais parcelas.\n\n### Erros\n\nEsta operação não expõe hoje códigos estáveis de erro (`extensions.code`) — identifique o cenário pela mensagem em `message`.\n\n| Código | Condição | O que fazer |\n| -------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente, inválido ou expirado, impedindo a derivação da loja autenticada. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | A loja autenticada não tem parcelamento (Unbox Pay) configurado. | Contate seu representante Unbox para configurar as regras de parcelamento da loja antes de chamar esta operação. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo para os cenários acima.\n\n### Notas\n\n- **`amountWithoutInterest`, `interestRatePercentage` e `installmentInterest` só aparecem quando a loja aplica juros** para aquele número específico de parcelas. Trate a ausência (`null`) como \"sem juros nesta opção\", não como dado faltando. Ver Exemplo acima para o formato completo.\n- **Sem efeito colateral e idempotente**: é apenas um cálculo, pode repetir a chamada livremente.\n- `input.amount` deve ser sempre em formato decimal da moeda — nunca em centavos."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"getInstallments\": {\n \"installments\": [\n {\n \"installment\": 10,\n \"amount\": 99.99,\n \"currency\": \"Example_String\",\n \"symbol\": \"Example_String\",\n \"amountWithoutInterest\": 99.99,\n \"interestRatePercentage\": 99.99,\n \"installmentInterest\": 99.99,\n \"totalInterest\": 99.99,\n \"totalBeforeInterest\": 99.99,\n \"total\": 99.99\n }\n ]\n }\n }\n}"},{"id":"910b5a68-02e7-4719-b16d-a068a0c6bf3a","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query GetInstallments($input: GetInstallmentsInput!) {\n getInstallments(input: $input) {\n installments {\n installment\n amount\n currency\n symbol\n amountWithoutInterest\n interestRatePercentage\n installmentInterest\n totalInterest\n totalBeforeInterest\n total\n }\n }\n}","variables":"{\n \"input\": {\n \"clientMutationId\": \"Example_String\",\n \"amount\": 99.99\n }\n}"}},"url":"{{base_url}}","description":"## getInstallments\n\n**Propósito:** Simula as opções de parcelamento disponíveis para um valor de compra, na loja autenticada.\n**Quando usar:** Chame antes de fechar um pedido (ex.: junto do `createExternalCheckout`) para exibir ao comprador quantas parcelas ele pode escolher e o valor de cada uma, incluindo juros quando a loja os aplica. Não reserva nem altera nada — é apenas um cálculo, pode ser chamado quantas vezes forem necessárias.\n**Autenticação:** `x-api-key` + `Authorization`. A loja é derivada automaticamente do seu token — não envie `shopId`, esse argumento não existe nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ------------------------ | -------- | ----------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `input.amount` | `Float!` | Sim | — | Valor total da compra, em unidades decimais da moeda da loja (ex.: `149.90` para R$ 149,90 — **não** envie em centavos). A API calcula as opções de parcelamento com base nesse valor. |\n| `input.clientMutationId` | `String` | Não | `null` | Identificador livre de correlação da sua chamada. Não é usado no cálculo e não volta na resposta desta operação — envie apenas se for útil para seu próprio rastreamento de requisições. |\n\nNão há validação explícita de `input.amount`: enviar `0` ou um valor negativo não retorna um erro de validação — apenas produz parcelas com valores sem sentido de negócio. Garanta que o valor enviado seja sempre positivo e condizente com o total real da compra.\n\n### Retorno\n\n`GetInstallmentsResponse`: um único campo, `installments`, com a lista completa de opções de parcelamento — uma entrada por número de parcelas, de 1 até o máximo configurado para a loja. Não é possível pedir apenas uma quantidade específica.\n\n| Propriedade | Tipo | Descrição |\n| --------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `installments` | `[ShopInstallment]!` | Lista de opções, uma por número de parcelas. |\n| `installments[].installment` | `Int!` | Número de parcelas desta opção (1, 2, 3...). |\n| `installments[].amount` | `Float!` | Valor de cada parcela para esse número de parcelas, já incluindo juros quando a loja os aplica. |\n| `installments[].currency` | `String!` | Código da moeda da loja (ex.: `BRL`). |\n| `installments[].symbol` | `String!` | Símbolo da moeda (ex.: `R$`). |\n| `installments[].amountWithoutInterest` | `Float` | Valor da parcela sem juros. Vem preenchido só quando a loja aplica juros para esse número de parcelas; caso contrário é `null`. |\n| `installments[].interestRatePercentage` | `Float` | Percentual de juros aplicado **uma única vez sobre o valor total da compra** (`input.amount`) para essa opção — não é uma taxa mensal nem composta por parcela. `null` quando não há juros nessa faixa de parcelas. |\n| `installments[].installmentInterest` | `Float` | Fração dos juros embutida em cada parcela: `totalInterest` dividido pelo número de parcelas dessa opção. `null` quando não há juros nessa faixa. |\n| `installments[].totalInterest` | `Float` | Total de juros cobrado sobre a compra inteira para esse número de parcelas (`0` quando não há juros). |\n| `installments[].totalBeforeInterest` | `Float` | O valor original enviado em `input.amount`, repetido em cada opção para referência. |\n| `installments[].total` | `Float` | Valor total a pagar para esse número de parcelas (`input.amount` + `totalInterest` daquela faixa). |\n\n**Cuidado com arredondamento:** `amount`, `total` e os demais valores são arredondados independentemente para duas casas decimais. `amount × installment` pode divergir de `total` em poucos centavos (ex.: 7 parcelas de `20.57` somam `143.99`, mas `total` pode ser `144.00`). Use sempre `total`/`totalInterest` como valores autoritativos — não os recalcule a partir de `amount`.\n\n### Exemplo\n\nIlustração (valores de uma loja hipotética, apenas para explicar o formato — os limiares reais variam por loja): `input.amount = 120`, com juros configurados a partir da 2ª parcela (10%), da 6ª (20%) e da 10ª (30%):\n\n| `installment` | `amount` | `amountWithoutInterest` | `interestRatePercentage` | `installmentInterest` | `totalInterest` | `total` |\n| ------------- | -------- | ----------------------- | ------------------------ | --------------------- | --------------- | ------- |\n| 1 | 120 | `null` | `null` | `null` | 0 | 120 |\n| 2 | 66 | 60 | 10 | 6 | 12 | 132 |\n| 6 | 24 | 20 | 20 | 4 | 24 | 144 |\n| 10 | 15.6 | 12 | 30 | 3.6 | 36 | 156 |\n\nNote que `total`/`totalInterest` são iguais entre parcelas 2–5 (mesma faixa de 10%) e entre 6–9 (mesma faixa de 20%) — só `amount` muda, dividindo o mesmo total em mais parcelas.\n\n### Erros\n\nEsta operação não expõe hoje códigos estáveis de erro (`extensions.code`) — identifique o cenário pela mensagem em `message`.\n\n| Código | Condição | O que fazer |\n| -------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |\n| _(sem código)_ | `Authorization` ausente, inválido ou expirado, impedindo a derivação da loja autenticada. | Refaça `signIn` e reenvie a chamada com um `Authorization` válido. |\n| _(sem código)_ | A loja autenticada não tem parcelamento (Unbox Pay) configurado. | Contate seu representante Unbox para configurar as regras de parcelamento da loja antes de chamar esta operação. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha, mesmo para os cenários acima.\n\n### Notas\n\n- **`amountWithoutInterest`, `interestRatePercentage` e `installmentInterest` só aparecem quando a loja aplica juros** para aquele número específico de parcelas. Trate a ausência (`null`) como \"sem juros nesta opção\", não como dado faltando. Ver Exemplo acima para o formato completo.\n- **Sem efeito colateral e idempotente**: é apenas um cálculo, pode repetir a chamada livremente.\n- `input.amount` deve ser sempre em formato decimal da moeda — nunca em centavos."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"}],"_postman_id":"27706560-f705-5730-aef1-414565c2325a"}],"id":"5655092f-807d-492c-9cd0-e827815bac41","_postman_id":"5655092f-807d-492c-9cd0-e827815bac41","description":""}],"id":"3b20b2af-80b0-49ee-9737-52cae0aa63d1","description":"Unbox Pay
\nSimulação de parcelamento: dado um valor de compra, retorna as opções de parcelas disponíveis para a loja autenticada, já com juros aplicados quando configurado. Use antes de fechar um pedido para exibir ao comprador as opções de pagamento parcelado.
\nTipos e enums compartilhados
\n\n\n\n| Tipo | \nCampos | \nDescrição | \n
\n\n\n\nShopInstallment | \ninstallment, amount, currency, symbol, amountWithoutInterest, interestRatePercentage, installmentInterest, totalInterest, totalBeforeInterest, total | \nUma opção de parcelamento (para um número específico de parcelas) dentro da lista retornada por getInstallments. | \n
\n\n
\n
Regras de negócio
\n\n- A loja precisa ter parcelamento (Unbox Pay) configurado. O número máximo de parcelas e a existência (ou não) de juros são definidos por configuração da loja, não por argumento da chamada — fale com seu contato Unbox para revisar essas regras.
\namount é sempre em unidades decimais da moeda, não em centavos (ex.: 149.90 para R$ 149,90). Isso é diferente de outras operações desta API que usam valores monetários em centavos — confira sempre a unidade esperada por cada campo.- A resposta sempre traz a lista completa de opções, de 1 parcela até o máximo configurado para a loja — não há como pedir apenas uma quantidade específica de parcelas.
\n- Juros, quando configurados, são aplicados por faixa de número de parcelas (ex.: sem juros até 5 parcelas, uma taxa a partir de 6, outra a partir de 10). Dentro da mesma faixa, o valor total pago é igual — o que muda é apenas quantas parcelas dividem esse total.
\n
\n","_postman_id":"3b20b2af-80b0-49ee-9737-52cae0aa63d1"},{"name":"Webhooks","item":[{"name":"Mutation","item":[{"name":"[Mutation] subscribeToWebhook","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function() {"," pm.response.to.have.status(200);","});","","pm.test(\"No GraphQL errors\", function() {"," const json = pm.response.json();"," pm.expect(json.errors).to.be.undefined;","});","","pm.test(\"Returns subscribeToWebhook data\", function() {"," const json = pm.response.json();"," pm.expect(json.data).to.have.property(\"subscribeToWebhook\");","});","","pm.test(\"Response time is acceptable\", function() {"," pm.expect(pm.response.responseTime).to.be.below(2000);","});"]}}],"id":"37a24d25-ada4-55f3-89f7-5056dfeb616c","request":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation SubscribeToWebhook($input: SubscribeToWebhookInput) {\n subscribeToWebhook(input: $input) {\n _id\n eventType\n secret\n endpoint\n createdAt\n updatedAt\n }\n}","variables":"{\n \"input\": {\n \"eventType\": \"PING\",\n \"endpoint\": \"Example_String\"\n }\n}"}},"url":"{{base_url}}","description":"subscribeToWebhook
\nPropósito: Registra um endpoint HTTP para receber notificações assíncronas (webhooks) de um tipo de evento.\nQuando usar: Configure uma assinatura para ser notificado sobre eventos de pedido (criação e mudança de status) sem precisar consultar a API por polling. Não é idempotente: chamar novamente com o mesmo eventType não atualiza uma assinatura existente — cria uma nova, independente, com seu próprio secret (ver Notas).\nAutenticação: x-api-key + Authorization. O shop é identificado a partir do seu token — não há argumento de shop nesta operação.
\nArgumentos
\n\n\n\n| Nome | \nTipo | \nObrigatório | \nDefault | \nDescrição | \n
\n\n\n\ninput.eventType | \nWebhookEventTypeEnum! | \nSim | \n- | \nTipo de evento a assinar. Valores: PING, ORDER_CREATED, ORDER_STATUS_UPDATE. | \n
\n\ninput.endpoint | \nString! | \nSim | \n- | \nURL HTTP(S) que receberá as entregas deste evento. Deve ser uma URL válida e acessível publicamente. | \n
\n\n
\n
Retorno
\nRetorna o registro da assinatura recém-criada.
\n\n\n\n| Propriedade | \nTipo | \nDescrição | \n
\n\n\n\n_id | \nString! | \nIdentificador da assinatura. | \n
\n\neventType | \nWebhookEventTypeEnum! | \nTipo de evento assinado. | \n
\n\nsecret | \nString! | \nSegredo usado para verificar a assinatura HMAC das entregas deste endpoint (header X-Unbox-Signature). É retornado apenas nesta chamada. Trate como credencial: armazene com segurança e nunca o exiba em logs, URLs ou telas. | \n
\n\nendpoint | \nString! | \nURL registrada para receber as entregas. | \n
\n\ncreatedAt | \nAWSDate! | \nData de criação da assinatura, no formato AAAA-MM-DD (escalar somente-data, sem horário). | \n
\n\nupdatedAt | \nAWSDate! | \nData da última atualização da assinatura, mesmo formato de createdAt. | \n
\n\n
\n
Erros
\n\n\n\n| Código | \nCondição | \nO que fazer | \n
\n\n\n\n| Erro de validação de entrada | \ninput.endpoint não é uma URL válida, input.eventType não é um dos valores aceitos, ou algum dos dois está ausente. Não há um extensions.code estável documentado para este caso — identifique-o pelo texto de errors[].message. | \nCorrija o campo indicado na mensagem de erro e tente novamente. | \n
\n\n
\n
\nGraphQL responde HTTP 200 com errors[] em caso de falha de negócio.
\n
\nNotas
\n\n- O
secret só é exposto nesta chamada — não existe outra operação para recuperá-lo depois. Trate-o como credencial (armazene com segurança, nunca o exponha em logs ou telas). Se perdê-lo, a única forma de obter um novo é assinar novamente (o que cria uma assinatura adicional, não substitui a anterior). \n- Logo após o registro, um evento
PING (data: { \"ping\": \"ping\" }) é disparado automaticamente para o endpoint informado, para permitir verificar que ele está acessível e que a assinatura HMAC pode ser validada corretamente do seu lado. Esse envio é assíncrono: sucesso ou falha na entrega do PING não afeta o retorno desta mutation (a assinatura já foi criada e é retornada normalmente). \n- Chamar
subscribeToWebhook novamente com o mesmo eventType não atualiza nem substitui uma assinatura existente — cria uma nova, independente, com seu próprio secret. Isso pode resultar em entregas duplicadas do mesmo evento para os endpoints de todas as assinaturas ativas daquele tipo. Nesta versão da API não há operação para listar, atualizar ou remover assinaturas já criadas. \n- Para o formato completo da entrega, verificação de assinatura (HMAC) e política de reenvio, veja a descrição do folder \"Webhooks\".
\n
\n","urlObject":{"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e9c7175a-9c58-4d4f-98d2-60d057d31061","name":"200 - subscribeToWebhook","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation SubscribeToWebhook($input: SubscribeToWebhookInput) {\n subscribeToWebhook(input: $input) {\n _id\n eventType\n secret\n endpoint\n createdAt\n updatedAt\n }\n}","variables":"{\n \"input\": {\n \"eventType\": \"PING\",\n \"endpoint\": \"Example_String\"\n }\n}"}},"url":"{{base_url}}","description":"## subscribeToWebhook\n\n**Propósito:** Registra um endpoint HTTP para receber notificações assíncronas (webhooks) de um tipo de evento.\n**Quando usar:** Configure uma assinatura para ser notificado sobre eventos de pedido (criação e mudança de status) sem precisar consultar a API por polling. Não é idempotente: chamar novamente com o mesmo `eventType` **não atualiza** uma assinatura existente — cria uma nova, independente, com seu próprio `secret` (ver Notas).\n**Autenticação:** `x-api-key` + `Authorization`. O shop é identificado a partir do seu token — não há argumento de shop nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------- | ----------------------- | ----------- | ------- | ---------------------------------------------------------------------------------------------------- |\n| `input.eventType` | `WebhookEventTypeEnum!` | Sim | - | Tipo de evento a assinar. Valores: `PING`, `ORDER_CREATED`, `ORDER_STATUS_UPDATE`. |\n| `input.endpoint` | `String!` | Sim | - | URL HTTP(S) que receberá as entregas deste evento. Deve ser uma URL válida e acessível publicamente. |\n\n### Retorno\n\nRetorna o registro da assinatura recém-criada.\n\n| Propriedade | Tipo | Descrição |\n| ----------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador da assinatura. |\n| `eventType` | `WebhookEventTypeEnum!` | Tipo de evento assinado. |\n| `secret` | `String!` | Segredo usado para verificar a assinatura HMAC das entregas deste endpoint (header `X-Unbox-Signature`). É retornado **apenas nesta chamada**. **Trate como credencial: armazene com segurança e nunca o exiba em logs, URLs ou telas.** |\n| `endpoint` | `String!` | URL registrada para receber as entregas. |\n| `createdAt` | `AWSDate!` | Data de criação da assinatura, no formato `AAAA-MM-DD` (escalar somente-data, sem horário). |\n| `updatedAt` | `AWSDate!` | Data da última atualização da assinatura, mesmo formato de `createdAt`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| Erro de validação de entrada | `input.endpoint` não é uma URL válida, `input.eventType` não é um dos valores aceitos, ou algum dos dois está ausente. Não há um `extensions.code` estável documentado para este caso — identifique-o pelo texto de `errors[].message`. | Corrija o campo indicado na mensagem de erro e tente novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- O `secret` só é exposto nesta chamada — não existe outra operação para recuperá-lo depois. **Trate-o como credencial** (armazene com segurança, nunca o exponha em logs ou telas). Se perdê-lo, a única forma de obter um novo é assinar novamente (o que cria uma assinatura adicional, não substitui a anterior).\n- Logo após o registro, um evento `PING` (`data: { \"ping\": \"ping\" }`) é disparado automaticamente para o `endpoint` informado, para permitir verificar que ele está acessível e que a assinatura HMAC pode ser validada corretamente do seu lado. Esse envio é assíncrono: sucesso ou falha na entrega do `PING` **não** afeta o retorno desta mutation (a assinatura já foi criada e é retornada normalmente).\n- Chamar `subscribeToWebhook` novamente com o mesmo `eventType` não atualiza nem substitui uma assinatura existente — cria uma nova, independente, com seu próprio `secret`. Isso pode resultar em entregas duplicadas do mesmo evento para os endpoints de todas as assinaturas ativas daquele tipo. Nesta versão da API não há operação para listar, atualizar ou remover assinaturas já criadas.\n- Para o formato completo da entrega, verificação de assinatura (HMAC) e política de reenvio, veja a descrição do folder \"Webhooks\"."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"subscribeToWebhook\": {\n \"_id\": \"Example_String\",\n \"eventType\": \"PING\",\n \"secret\": \"Example_String\",\n \"endpoint\": \"Example_String\",\n \"createdAt\": \"2025-01-15\",\n \"updatedAt\": \"2025-01-15\"\n }\n }\n}"},{"id":"7c735242-1a13-4151-9c3b-5411f89abfb1","name":"401 - Unauthorized (missing x-api-key header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation SubscribeToWebhook($input: SubscribeToWebhookInput) {\n subscribeToWebhook(input: $input) {\n _id\n eventType\n secret\n endpoint\n createdAt\n updatedAt\n }\n}","variables":"{\n \"input\": {\n \"eventType\": \"PING\",\n \"endpoint\": \"Example_String\"\n }\n}"}},"url":"{{base_url}}","description":"## subscribeToWebhook\n\n**Propósito:** Registra um endpoint HTTP para receber notificações assíncronas (webhooks) de um tipo de evento.\n**Quando usar:** Configure uma assinatura para ser notificado sobre eventos de pedido (criação e mudança de status) sem precisar consultar a API por polling. Não é idempotente: chamar novamente com o mesmo `eventType` **não atualiza** uma assinatura existente — cria uma nova, independente, com seu próprio `secret` (ver Notas).\n**Autenticação:** `x-api-key` + `Authorization`. O shop é identificado a partir do seu token — não há argumento de shop nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------- | ----------------------- | ----------- | ------- | ---------------------------------------------------------------------------------------------------- |\n| `input.eventType` | `WebhookEventTypeEnum!` | Sim | - | Tipo de evento a assinar. Valores: `PING`, `ORDER_CREATED`, `ORDER_STATUS_UPDATE`. |\n| `input.endpoint` | `String!` | Sim | - | URL HTTP(S) que receberá as entregas deste evento. Deve ser uma URL válida e acessível publicamente. |\n\n### Retorno\n\nRetorna o registro da assinatura recém-criada.\n\n| Propriedade | Tipo | Descrição |\n| ----------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador da assinatura. |\n| `eventType` | `WebhookEventTypeEnum!` | Tipo de evento assinado. |\n| `secret` | `String!` | Segredo usado para verificar a assinatura HMAC das entregas deste endpoint (header `X-Unbox-Signature`). É retornado **apenas nesta chamada**. **Trate como credencial: armazene com segurança e nunca o exiba em logs, URLs ou telas.** |\n| `endpoint` | `String!` | URL registrada para receber as entregas. |\n| `createdAt` | `AWSDate!` | Data de criação da assinatura, no formato `AAAA-MM-DD` (escalar somente-data, sem horário). |\n| `updatedAt` | `AWSDate!` | Data da última atualização da assinatura, mesmo formato de `createdAt`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| Erro de validação de entrada | `input.endpoint` não é uma URL válida, `input.eventType` não é um dos valores aceitos, ou algum dos dois está ausente. Não há um `extensions.code` estável documentado para este caso — identifique-o pelo texto de `errors[].message`. | Corrija o campo indicado na mensagem de erro e tente novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- O `secret` só é exposto nesta chamada — não existe outra operação para recuperá-lo depois. **Trate-o como credencial** (armazene com segurança, nunca o exponha em logs ou telas). Se perdê-lo, a única forma de obter um novo é assinar novamente (o que cria uma assinatura adicional, não substitui a anterior).\n- Logo após o registro, um evento `PING` (`data: { \"ping\": \"ping\" }`) é disparado automaticamente para o `endpoint` informado, para permitir verificar que ele está acessível e que a assinatura HMAC pode ser validada corretamente do seu lado. Esse envio é assíncrono: sucesso ou falha na entrega do `PING` **não** afeta o retorno desta mutation (a assinatura já foi criada e é retornada normalmente).\n- Chamar `subscribeToWebhook` novamente com o mesmo `eventType` não atualiza nem substitui uma assinatura existente — cria uma nova, independente, com seu próprio `secret`. Isso pode resultar em entregas duplicadas do mesmo evento para os endpoints de todas as assinaturas ativas daquele tipo. Nesta versão da API não há operação para listar, atualizar ou remover assinaturas já criadas.\n- Para o formato completo da entrega, verificação de assinatura (HMAC) e política de reenvio, veja a descrição do folder \"Webhooks\"."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"errorType\": \"UnauthorizedException\",\n \"message\": \"You are not authorized to make this call.\"\n }\n ]\n}"},{"id":"124d675d-7685-474f-a2c6-6cfb37f0c1f3","name":"401 - Unauthorized (missing Authorization header)","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{api_key}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation SubscribeToWebhook($input: SubscribeToWebhookInput) {\n subscribeToWebhook(input: $input) {\n _id\n eventType\n secret\n endpoint\n createdAt\n updatedAt\n }\n}","variables":"{\n \"input\": {\n \"eventType\": \"PING\",\n \"endpoint\": \"Example_String\"\n }\n}"}},"url":"{{base_url}}","description":"## subscribeToWebhook\n\n**Propósito:** Registra um endpoint HTTP para receber notificações assíncronas (webhooks) de um tipo de evento.\n**Quando usar:** Configure uma assinatura para ser notificado sobre eventos de pedido (criação e mudança de status) sem precisar consultar a API por polling. Não é idempotente: chamar novamente com o mesmo `eventType` **não atualiza** uma assinatura existente — cria uma nova, independente, com seu próprio `secret` (ver Notas).\n**Autenticação:** `x-api-key` + `Authorization`. O shop é identificado a partir do seu token — não há argumento de shop nesta operação.\n\n### Argumentos\n\n| Nome | Tipo | Obrigatório | Default | Descrição |\n| ----------------- | ----------------------- | ----------- | ------- | ---------------------------------------------------------------------------------------------------- |\n| `input.eventType` | `WebhookEventTypeEnum!` | Sim | - | Tipo de evento a assinar. Valores: `PING`, `ORDER_CREATED`, `ORDER_STATUS_UPDATE`. |\n| `input.endpoint` | `String!` | Sim | - | URL HTTP(S) que receberá as entregas deste evento. Deve ser uma URL válida e acessível publicamente. |\n\n### Retorno\n\nRetorna o registro da assinatura recém-criada.\n\n| Propriedade | Tipo | Descrição |\n| ----------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | `String!` | Identificador da assinatura. |\n| `eventType` | `WebhookEventTypeEnum!` | Tipo de evento assinado. |\n| `secret` | `String!` | Segredo usado para verificar a assinatura HMAC das entregas deste endpoint (header `X-Unbox-Signature`). É retornado **apenas nesta chamada**. **Trate como credencial: armazene com segurança e nunca o exiba em logs, URLs ou telas.** |\n| `endpoint` | `String!` | URL registrada para receber as entregas. |\n| `createdAt` | `AWSDate!` | Data de criação da assinatura, no formato `AAAA-MM-DD` (escalar somente-data, sem horário). |\n| `updatedAt` | `AWSDate!` | Data da última atualização da assinatura, mesmo formato de `createdAt`. |\n\n### Erros\n\n| Código | Condição | O que fazer |\n| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| Erro de validação de entrada | `input.endpoint` não é uma URL válida, `input.eventType` não é um dos valores aceitos, ou algum dos dois está ausente. Não há um `extensions.code` estável documentado para este caso — identifique-o pelo texto de `errors[].message`. | Corrija o campo indicado na mensagem de erro e tente novamente. |\n\n> GraphQL responde HTTP 200 com `errors[]` em caso de falha de negócio.\n\n### Notas\n\n- O `secret` só é exposto nesta chamada — não existe outra operação para recuperá-lo depois. **Trate-o como credencial** (armazene com segurança, nunca o exponha em logs ou telas). Se perdê-lo, a única forma de obter um novo é assinar novamente (o que cria uma assinatura adicional, não substitui a anterior).\n- Logo após o registro, um evento `PING` (`data: { \"ping\": \"ping\" }`) é disparado automaticamente para o `endpoint` informado, para permitir verificar que ele está acessível e que a assinatura HMAC pode ser validada corretamente do seu lado. Esse envio é assíncrono: sucesso ou falha na entrega do `PING` **não** afeta o retorno desta mutation (a assinatura já foi criada e é retornada normalmente).\n- Chamar `subscribeToWebhook` novamente com o mesmo `eventType` não atualiza nem substitui uma assinatura existente — cria uma nova, independente, com seu próprio `secret`. Isso pode resultar em entregas duplicadas do mesmo evento para os endpoints de todas as assinaturas ativas daquele tipo. Nesta versão da API não há operação para listar, atualizar ou remover assinaturas já criadas.\n- Para o formato completo da entrega, verificação de assinatura (HMAC) e política de reenvio, veja a descrição do folder \"Webhooks\"."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"message\": \"Unauthorized - No authenticated user\",\n \"errorType\": \"UnauthorizedException\"\n }\n ]\n}"}],"_postman_id":"37a24d25-ada4-55f3-89f7-5056dfeb616c"}],"id":"7658fedd-b892-4e77-8ed5-23d6f66aee91","_postman_id":"7658fedd-b892-4e77-8ed5-23d6f66aee91","description":""}],"id":"0b9968e3-db02-4ffc-933d-ecfa75f0ff39","description":"Webhooks
\nDomínio de notificações assíncronas. Permite que a loja parceira registre um endpoint HTTP que passa a receber eventos em tempo real (pedido criado, mudança de status de pedido), eliminando a necessidade de polling. Hoje expõe uma única operação, subscribeToWebhook.
\nTipos e enums compartilhados
\nWebhookEventTypeEnum
\n\n\n\n| Valor | \nDescrição | \n
\n\n\n\nPING | \nEvento de verificação enviado automaticamente logo após o registro de uma assinatura, para confirmar que o endpoint está acessível. | \n
\n\nORDER_CREATED | \nDisparado quando um novo pedido é criado. | \n
\n\nORDER_STATUS_UPDATE | \nDisparado quando o status do pedido (ou o status de pagamento do pedido) é atualizado. | \n
\n\n
\n
Cada evento é entregue como uma requisição HTTP POST para o endpoint informado no registro, com um corpo JSON no formato:
\n{\n \"_id\": \"<id único desta entrega>\",\n \"type\": \"ORDER_CREATED\",\n \"data\": { \"...\": \"...\" },\n \"createdAt\": \"2024-01-01T00:00:00.000Z\"\n}\n
\n\ntype é um dos valores de WebhookEventTypeEnum.data varia conforme type: para PING é { \"ping\": \"ping\" }; para eventos de pedido, é a representação do pedido relacionado ao evento.- Header
Content-Type: application/json. \n
\nVerificação de assinatura (HMAC)
\nToda entrega inclui o header X-Unbox-Signature: um HMAC-SHA256, em hexadecimal, calculado sobre o corpo bruto (JSON serializado) da requisição, usando como chave o secret retornado por subscribeToWebhook para aquela assinatura.
\nPara validar uma entrega recebida:
\n\n- Calcule o HMAC-SHA256 do corpo bruto (exatamente como recebido, antes de qualquer parsing) usando o seu
secret como chave. \n- Compare o resultado (hex) com o header
X-Unbox-Signature. Só processe o evento se forem idênticos; caso contrário, descarte a requisição. \n
\n\nTrate o secret como uma credencial: armazene-o de forma segura (nunca em logs, URLs ou repositórios de código) e nunca o exponha em respostas de API ou telas de suporte. Sem ele, qualquer terceiro poderia forjar entregas para o seu endpoint.
\n
\nPolítica de reenvio (retry)
\nSeu endpoint deve responder HTTP 200 dentro de um tempo curto (alguns segundos) para que a entrega seja considerada bem-sucedida. Qualquer resposta diferente de 200 — incluindo timeout — é tratada como falha de entrega.
\nEm caso de falha, a entrega é reenviada automaticamente algumas vezes, com backoff exponencial (o intervalo entre tentativas cresce a cada nova tentativa). Após esgotar as tentativas, o evento é descartado — não há reenvio manual nem fila de eventos perdidos exposta ao parceiro. Os valores exatos de timeout, número de tentativas e intervalo são operacionais e podem ser ajustados sem aviso prévio; não construa lógica que dependa de um número exato de tentativas.
\nRecomendação: responda 200 assim que receber e validar a assinatura do evento, processando o conteúdo de forma assíncrona no seu lado — isso minimiza a chance de timeout e de reentregas desnecessárias.
\nRegras de negócio
\n\n- Assinar novamente o mesmo
eventType (chamando subscribeToWebhook de novo) não substitui uma assinatura existente: cria uma assinatura independente adicional, com seu próprio secret. Se o mesmo evento for assinado mais de uma vez, o(s) endpoint(s) registrados recebem o mesmo evento várias vezes (uma entrega por assinatura ativa). \n- Nesta versão da API não há operação para listar, atualizar ou remover assinaturas de webhook já criadas.
\n
\n","_postman_id":"0b9968e3-db02-4ffc-933d-ecfa75f0ff39"}],"variable":[{"key":"base_url","value":"{{base_url}}","type":"string"}]}