1"use strict";(self.webpackChunkcoreshop_docs=self.webpackChunkcoreshop_docs||[]).push([[6149],{18284:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>d,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"Headless_Bundle/Mutations","title":"Mutations","description":"Authorize","source":"@site/versioned_docs/version-5.1/12_Headless_Bundle/03_Mutations.md","sourceDirName":"12_Headless_Bundle","slug":"/Headless_Bundle/Mutations","permalink":"/5.1/Headless_Bundle/Mutations","draft":false,"unlisted":false,"tags":[],"version":"5.1","sidebarPosition":3,"frontMatter":{},"sidebar":"defaultSidebar","previous":{"title":"Queries","permalink":"/5.1/Headless_Bundle/Queries"},"next":{"title":"Custom Queries / Mutations","permalink":"/5.1/Headless_Bundle/Custom_Queries"}}');var t=r(74848),s=r(28453);const a={},d="Mutations",i={},c=[{value:"Authorize",id:"authorize",level:2},{value:"Add to Order",id:"add-to-order",level:2},{value:"Remove Order Item",id:"remove-order-item",level:2},{value:"Update Order Item",id:"update-order-item",level:2},{value:"Password Reset Request",id:"password-reset-request",level:2},{value:"Password Reset Request Validate",id:"password-reset-request-validate",level:2},{value:"Password Reset",id:"password-reset",level:2},{value:"Add Order Voucher Code",id:"add-order-voucher-code",level:2},{value:"Remove Order Voucher Code",id:"remove-order-voucher-code",level:2},{value:"Guest Registration",id:"guest-registration",level:2},{value:"Guest Checkout Address",id:"guest-checkout-address",level:2},{value:"Checkout Shipping",id:"checkout-shipping",level:2},{value:"Checkout Payment",id:"checkout-payment",level:2},{value:"Checkout - Do",id:"checkout---do",level:2},{value:"Address Update",id:"address-update",level:2},{value:"Address Create",id:"address-create",level:2},{value:"Checkout Address",id:"checkout-address",level:2},{value:"Payment Create",id:"payment-create",level:2},{value:"Payment Capture",id:"payment-capture",level:2},{value:"Payment Status (After Capture)",id:"payment-status-after-capture",level:2}];function u(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"mutations",children:"Mutations"})}),"\n",(0,t.jsx)(n.h2,{id:"authorize",children:"Authorize"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopAuthorize(authorize: {username: "[email protected]", password: "[email protected]"}) {\n ... on CoreShopAuthorizeResult {\n token\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsxs)(n.p,{children:["Use the token as ",(0,t.jsx)(n.code,{children:'"Authorization": "Bearer ..."'})," token."]}),"\n",(0,t.jsx)(n.h2,{id:"add-to-order",children:"Add to Order"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopAddToOrder(addToOrder: {order: {token: "x1mJsJOx8c"}, orderItem: {productId: 85, quantity: 1}}) {\n ... on CoreShopAddToOrderResult {\n order {\n id\n token\n items {\n ... on object_CoreShopOrderItem {\n quantity\n product {\n ... on object_CoreShopProduct {\n name\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"remove-order-item",children:"Remove Order Item"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopRemoveOrderItem(removeOrderItem: {order: {token: "x1mJsJOx8c"}, orderItem: {id: 150}}) {\n ... on CoreShopRemoveOrderItemResult {\n order {\n id\n token\n items {\n ... on object_CoreShopOrderItem {\n id\n quantity\n product {\n ... on object_CoreShopProduct {\n name\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"update-order-item",children:"Update Order Item"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopUpdateOrderItem(updateOrderItem: {order: {token: "x1mJsJOx8c"}, orderItem: {id: 152, quantity: 1}}) {\n ... on CoreShopUpdateOrderItemResult {\n order {\n id\n token\n items {\n ... on object_CoreShopOrderItem {\n id\n quantity\n product {\n ... on object_CoreShopProduct {\n name\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n ... on CoreShopValidationError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"password-reset-request",children:"Password Reset Request"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopPasswordResetRequest
1(passwordResetRequest: {username: "[email protected]"}) {\n ... on CoreShopPasswordResetRequestResult {\n success\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"password-reset-request-validate",children:"Password Reset Request Validate"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopPasswordResetRequestValidate(passwordResetRequestValidate:{token: "656fa9db64f4895870b1cc5e045afe20"}) {\n ... on CoreShopPasswordResetRequestValidateResult {\n \tsuccess\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"password-reset",children:"Password Reset"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopPasswordReset(passwordReset: {token: "656fa9db64f4895870b1cc5e045afe20", password: "[email protected]"}) {\n ... on CoreShopPasswordResetResult {\n success\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"add-order-voucher-code",children:"Add Order Voucher Code"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopAddOrderVoucherCode(addOrderVoucherCode: {order: {token: "x1mJsJOx8c"}, orderVoucherCode: {code: "test"}}) {\n ... on CoreShopAddOrderVoucherCodeResult {\n order {\n id\n token\n priceRuleItems {\n ... on fieldcollection_CoreShopProposalCartPriceRuleItem {\n cartPriceRule {\n name\n }\n voucherCode\n }\n }\n items {\n ... on object_CoreShopOrderItem {\n id\n quantity\n product {\n ... on object_CoreShopProduct {\n name\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n ... on CoreShopValidationError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"remove-order-voucher-code",children:"Remove Order Voucher Code"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopRemoveOrderVoucherCode(removeOrderVoucherCode: {order: {token: "x1mJsJOx8c"}, orderVoucherCode: {code: "test"}}) {\n ... on CoreShopRemoveOrderVoucherCodeResult {\n order {\n id\n token\n priceRuleItems {\n ... on fieldcollection_CoreShopProposalCartPriceRuleItem {\n cartPriceRule {\n name\n }\n voucherCode\n }\n }\n items {\n ... on object_CoreShopOrderItem {\n id\n quantity\n product {\n ... on object_CoreShopProduct {\n name\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n ... on CoreShopValidationError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"guest-registration",children:"Guest Registration"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutGuestRegistration(checkoutGuestRegistration: {\n customer:{\n salutation: "mr"\n gender: "herr"\n firstname:"test"\n lastname:"test"\n email:"[email protected]"\n address: {\n salutation: "mr"\n firstname:"test"\n lastname:"testinger"\n street:"test"\n number:"1"\n postcode:"4600"\n city:"wels"\n country:Austria\n }\n }\n order: {\n token: "123"\n }\n }) {\n __typename\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"guest-checkout-address",children:"Guest Checkout Address"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutGuestAddress(checkoutGuestAddress: {\n shippingAddress: {\n country: Austr
1ia\n salutation: "mr"\n firstname:"Test"\n lastname:"Testinger"\n street:"test"\n city:"test"\n postcode:"test"\n number: "123"\n }\n invoiceAddress: {\n country: Austria\n salutation: "mr"\n firstname:"blub"\n lastname:"Blubinger"\n street:"blub"\n city:"blub"\n postcode:"blub"\n number: "123"\n }\n order: {\n token: "x1mJsJOx8c"\n }\n invoiceAddressIsShippingAddress: false\n }) {\n ... on CoreShopCheckoutGuestAddressResult {\n order {\n id\n }\n }\n ... on CoreShopError {\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"checkout-shipping",children:"Checkout Shipping"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutShipping(checkoutShipping: {order: {token: "x1mJsJOx8c"}, carrier: SEcond}) {\n ... on CoreShopCheckoutShippingResult {\n order {\n id\n carrier {\n identifier\n translations {\n ... on CoreshopCarrierTranslation__List {\n items {\n ... on CoreshopCarrierTranslation {\n title\n }\n }\n }\n }\n }\n }\n }\n ... on CoreShopError {\n __typename\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"checkout-payment",children:"Checkout Payment"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutPaymentProvider(checkoutPaymentProvider: {order: {token: "123"}, paymentProvider: Bankwire}) {\n ... on CoreShopCheckoutPaymentProviderResult {\n order {\n id\n paymentProvider {\n identifier\n translations {\n total\n items {\n locale\n title\n }\n }\n }\n totalGross\n totalNet\n }\n }\n ... on CoreShopError {\n __typename\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"checkout---do",children:"Checkout - Do"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutOrder(checkoutOrder: {order: {token: "123"}}) {\n ... on CoreShopCheckoutOrderResult {\n response\n }\n ... on CoreShopError {\n __typename\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"address-update",children:"Address Update"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopUpdateAddress(updateAddress: {\n addressId: 404\n address: {\n salutation: "mr"\n company: "blub"\n firstname: "asd"\n lastname: "lastname"\n street: "street"\n number: "number"\n postcode: "postcode"\n city: "city"\n country: Austria\n phoneNumber: "phoneNumber"\n }\n }) {\n __typename\n ... on CoreShopUpdateAddressResult {\n address {\n city\n }\n }\n ... on CoreShopError {\n __typename\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"address-create",children:"Address Create"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCreateAddress(createAddress: {\n address: {\n salutation: "mr"\n company: "blub"\n firstname: "asd"\n lastname: "lastname"\n street: "street"\n number: "number"\n postcode: "postcode"\n city: "city"\n country: Austr
1ia\n phoneNumber: "phoneNumber"\n }\n }) {\n __typename\n ... on CoreShopCreateAddressResult {\n address {\n city\n }\n }\n ... on CoreShopError {\n __typename\n message\n }\n ... on CoreShopValidationError {\n message\n violations {\n propertyPath\n message\n }\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"checkout-address",children:"Checkout Address"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutAddress(checkoutAddress: {order: {token:"asdf"}, invoiceAddressId: 403, invoiceAddressIsShippingAddress: true}) {\n __typename\n ... on CoreShopCheckoutAddressResult {\n order {\n shippingAddress {\n ... on object_CoreShopAddress {\n id\n }\n }\n invoiceAddress {\n ... on object_CoreShopAddress {\n id\n }\n }\n }\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"payment-create",children:"Payment Create"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutOrderCreatePayment(checkoutOrderCreatePayment: {order: {token: "asdf"}}) {\n __typename\n ... on CoreShopCheckoutOrderCreatePaymentResult {\n hash\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"payment-capture",children:"Payment Capture"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutPaymentCapture(checkoutPaymentCapture: {token: "O06BbPz42Ha7BNezTe5gLWRtzSisrcIUCv_Jx5DjSdM"}) {\n __typename\n ... on CoreShopCheckoutPaymentCaptureResult {\n statusHash\n redirectUrl\n redirectStatus\n redirectHeaders\n\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})}),"\n",(0,t.jsx)(n.h2,{id:"payment-status-after-capture",children:"Payment Status (After Capture)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:'mutation {\n CoreShopCheckoutPaymentAfterCapture(checkoutPaymentAfterCapture: {token: "h__BWoD_0zl29iy2mk6YJRIFryW4DXd54gc3DBuQApU"}) {\n __typename\n ... on CoreShopCheckoutPaymentAfterCaptureResult {\n status\n }\n ... on CoreShopError {\n message\n }\n }\n}\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(u,{...e})}):u(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>d});var o=r(96540);const t={},s=o.createContext(t);function a(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.