checkpoint

Author: alexphelps

components/graphql-operation.tsx

@@ -20,10 +20,10 @@ interface GraphQLOperationProps {
   name: string;
   signature: string;
   variablesExample?: string;
+  responseExample?: string;
   args?: GraphQLField[];
   returnFields?: GraphQLField[];
   returnType?: string;
-
   description?: string;
   children?: React.ReactNode;
 }
@@ -91,10 +91,10 @@ export function GraphQLOperation({
   name,
   signature,
   variablesExample,
+  responseExample,
   args,
   returnFields,
   returnType,
-
   description,
   children,
 }: GraphQLOperationProps) {
@@ -170,6 +170,16 @@ export function GraphQLOperation({
               }}
             />
           )}
+
+          {responseExample && (
+            <DynamicCodeBlock
+              lang="json"
+              code={responseExample}
+              codeblock={{
+                title: 'JSON Response',
+              }}
+            />
+          )}
         </div>
       </div>
     </div>

content/docs/storefront/graphql/mutations/add-cart-lines.mdx

@@ -12,6 +12,7 @@ import { GraphQLOperation } from '@/components/graphql-operation';
   description={"Register a user"}
   signature={"mutation Register($input: RegisterInput!) {\n  register(input: $input) {\n    success\n    errors\n    token\n    clientMutationId\n  }\n}"}
   variablesExample={"{\n  \"input\": {\n    \"email\": \"<your-value>\",\n    \"password\": \"<your-value>\",\n    \"firstName\": \"<your-value>\",\n    \"lastName\": \"<your-value>\",\n    \"phoneNumber\": \"<your-value>\",\n    \"acceptsMarketing\": true,\n    \"language\": \"en\",\n    \"metadata\": {},\n    \"clientMutationId\": \"<your-value>\"\n  }\n}"}
+  responseExample={"{\n  \"data\": {\n    \"register\": {\n      \"success\": true,\n      \"errors\": null,\n      \"token\": \"<your-value>\",\n      \"clientMutationId\": \"<your-value>\"\n    }\n  }\n}"}
   args={[{"name":"input","type":"RegisterInput!","badges":["non-null"],"fields":[{"name":"email","type":"String!","badges":["non-null"]},{"name":"password","type":"String!","badges":["non-null"]},{"name":"firstName","type":"String","badges":[]},{"name":"lastName","type":"String","badges":[]},{"name":"phoneNumber","type":"String","badges":[]},{"name":"acceptsMarketing","type":"Boolean","badges":[]},{"name":"language","type":"LanguageEnum","badges":[]},{"name":"metadata","type":"GenericScalar","badges":[]},{"name":"clientMutationId","type":"String","badges":[]}]}]}
   returnType="RegisterPayload"
   returnFields={[{"name":"success","type":"Boolean","badges":[]},{"name":"errors","type":"ExpectedErrorType","badges":[]},{"name":"token","type":"String","badges":[]},{"name":"clientMutationId","type":"String","badges":[]}]}

content/docs/storefront/graphql/mutations/add-voucher.mdx

@@ -12,6 +12,7 @@ import { GraphQLOperation } from '@/components/graphql-operation';
   description={"Obtain JSON web token for given user."}
   signature={"mutation TokenAuth($input: ObtainJSONWebTokenInput!) {\n  tokenAuth(input: $input) {\n    payload\n    refreshExpiresIn\n    success\n    errors\n    clientMutationId\n    token\n  }\n}"}
   variablesExample={"{\n  \"input\": {\n    \"clientMutationId\": \"<your-value>\",\n    \"email\": \"<your-value>\",\n    \"password\": \"<your-value>\"\n  }\n}"}
+  responseExample={"{\n  \"data\": {\n    \"tokenAuth\": {\n      \"payload\": {},\n      \"refreshExpiresIn\": 1,\n      \"success\": true,\n      \"errors\": null,\n      \"user\": {\n        \"id\": \"<id>\",\n        \"lastLogin\": \"2026-01-01T00:00:00Z\",\n        \"isActive\": true,\n        \"email\": \"<your-value>\",\n        \"phoneNumber\": \"<your-value>\",\n        \"firstName\": \"<your-value>\",\n        \"lastName\": \"<your-value>\",\n        \"ip\": \"<your-value>\",\n        \"language\": \"<your-value>\",\n        \"isBlocked\": true,\n        \"userType\": \"LEAD\",\n        \"acceptsMarketing\": true,\n        \"metadata\": {},\n        \"userAgent\": \"<your-value>\",\n        \"firstPurchaseDate\": \"2026-01-01T00:00:00Z\",\n        \"lastPurchaseDate\": \"2026-01-01T00:00:00Z\",\n        \"dateJoined\": \"2026-01-01T00:00:00Z\",\n        \"agentMarketingAttributions\": [\n          {\n            \"id\": \"<id>\",\n            \"utmSource\": \"<your-value>\",\n            \"utmMedium\": \"<your-value>\",\n            \"utmCampaign\": \"<your-value>\",\n            \"utmTerm\": \"<your-value>\",\n            \"utmContent\": \"<your-value>\",\n            \"gclid\": \"<your-value>\",\n            \"campaign\": \"<your-value>\",\n            \"metadata\": {},\n            \"affiliate\": \"<your-value>\",\n            \"subaffiliate1\": \"<your-value>\",\n            \"subaffiliate2\": \"<your-value>\",\n            \"subaffiliate3\": \"<your-value>\",\n            \"subaffiliate4\": \"<your-value>\",\n            \"subaffiliate5\": \"<your-value>\"\n          }\n        ],\n        \"pk\": 1\n      },\n      \"clientMutationId\": \"<your-value>\",\n      \"token\": \"<your-value>\"\n    }\n  }\n}"}
   args={[{"name":"input","type":"ObtainJSONWebTokenInput!","badges":["non-null"],"fields":[{"name":"clientMutationId","type":"String","badges":[]},{"name":"email","type":"String!","badges":["non-null"]},{"name":"password","type":"String!","badges":["non-null"]}]}]}
   returnType="ObtainJSONWebTokenPayload"
   returnFields={[{"name":"payload","type":"GenericScalar!","badges":["non-null"]},{"name":"refreshExpiresIn","type":"Int!","badges":["non-null"]},{"name":"success","type":"Boolean","badges":[]},{"name":"errors","type":"ExpectedErrorType","badges":[]},{"name":"user","type":"UserNode","badges":[],"fields":[{"name":"id","type":"ID!","description":"The ID of the object","badges":["non-null"]},{"name":"lastLogin","type":"DateTime","badges":[]},{"name":"isActive","type":"Boolean!","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts.","badges":["non-null"]},{"name":"email","type":"String","badges":[]},{"name":"phoneNumber","type":"String","badges":[]},{"name":"firstName","type":"String!","badges":["non-null"]},{"name":"lastName","type":"String!","badges":["non-null"]},{"name":"ip","type":"String","badges":[]},{"name":"language","type":"String","badges":[]},{"name":"isBlocked","type":"Boolean!","badges":["non-null"]},{"name":"userType","type":"UserUserUserTypeChoices!","badges":["non-null"]},{"name":"acceptsMarketing","type":"Boolean!","badges":["non-null"]},{"name":"metadata","type":"GenericScalar","badges":[]},{"name":"userAgent","type":"String","badges":[]},{"name":"firstPurchaseDate","type":"DateTime","badges":[]},{"name":"lastPurchaseDate","type":"DateTime","badges":[]},{"name":"dateJoined","type":"DateTime!","badges":["non-null"]},{"name":"agentMarketingAttributions","type":"[AttributionNode!]!","badges":["non-null","list"],"fields":[{"name":"id","type":"ID!","badges":["non-null"]},{"name":"utmSource","type":"String","badges":[]},{"name":"utmMedium","type":"String","badges":[]},{"name":"utmCampaign","type":"String","badges":[]},{"name":"utmTerm","type":"String","badges":[]},{"name":"utmContent","type":"String","badges":[]},{"name":"gclid","type":"String","badges":[]},{"name":"campaign","type":"String","badges":[]},{"name":"metadata","type":"GenericScalar","badges":[]},{"name":"affiliate","type":"String","badges":[]},{"name":"subaffiliate1","type":"String","badges":[]},{"name":"subaffiliate2","type":"String","badges":[]},{"name":"subaffiliate3","type":"String","badges":[]},{"name":"subaffiliate4","type":"String","badges":[]},{"name":"subaffiliate5","type":"String","badges":[]}]},{"name":"pk","type":"Int","badges":[]}]},{"name":"clientMutationId","type":"String","badges":[]},{"name":"token","type":"String!","badges":["non-null"]}]}

content/docs/storefront/graphql/mutations/create-cart.mdx

@@ -12,6 +12,7 @@ import { GraphQLOperation } from '@/components/graphql-operation';
   description={"Update a user"}
   signature={"mutation UpdateAccount($input: UpdateAccountInput!) {\n  updateAccount(input: $input) {\n    success\n    errors\n    clientMutationId\n  }\n}"}
   variablesExample={"{\n  \"input\": {\n    \"email\": \"<your-value>\",\n    \"firstName\": \"<your-value>\",\n    \"lastName\": \"<your-value>\",\n    \"phoneNumber\": \"<your-value>\",\n    \"acceptsMarketing\": true,\n    \"language\": \"en\",\n    \"metadata\": {},\n    \"clientMutationId\": \"<your-value>\"\n  }\n}"}
+  responseExample={"{\n  \"data\": {\n    \"updateAccount\": {\n      \"success\": true,\n      \"errors\": null,\n      \"clientMutationId\": \"<your-value>\"\n    }\n  }\n}"}
   args={[{"name":"input","type":"UpdateAccountInput!","badges":["non-null"],"fields":[{"name":"email","type":"String","badges":[]},{"name":"firstName","type":"String","badges":[]},{"name":"lastName","type":"String","badges":[]},{"name":"phoneNumber","type":"String","badges":[]},{"name":"acceptsMarketing","type":"Boolean","badges":[]},{"name":"language","type":"LanguageEnum","badges":[]},{"name":"metadata","type":"GenericScalar","badges":[]},{"name":"clientMutationId","type":"String","badges":[]}]}]}
   returnType="UpdateAccountPayload"
   returnFields={[{"name":"success","type":"Boolean","badges":[]},{"name":"errors","type":"ExpectedErrorType","badges":[]},{"name":"clientMutationId","type":"String","badges":[]}]}