securityDefinitions: api_key: type: apiKey name: api_key in: header swagger: "2.0" info: version: 2.4.6 title: Commerce Customer REST endpoints - All inclusive description: $ref: intro/redocly-intro.md host: example.com basePath: /rest/default schemes: - https tags: - name: applepay/auth - name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - name: carts/guest-carts/{cartId}/giftCards - name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} - name: carts/mine - name: carts/mine/balance/apply - name: carts/mine/checkGiftCard/{giftCardCode} - name: carts/mine/collect-totals - name: carts/mine/payment-information - name: carts/mine/po-payment-information - name: carts/mine/set-payment-information - name: customers - name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - name: customers/isEmailAvailable - name: customers/me/activate - name: customers/me/password - name: customers/password - name: customers/resetPassword - name: directory/countries - name: directory/countries/{countryId} - name: directory/currency - name: giftregistry/mine/estimate-shipping-methods - name: guest-carts - name: guest-carts/{cartId} - name: guest-carts/{cartId}/billing-address - name: guest-carts/{cartId}/collect-totals - name: guest-carts/{cartId}/coupons - name: guest-carts/{cartId}/coupons/{couponCode} - name: guest-carts/{cartId}/estimate-shipping-methods - name: guest-carts/{cartId}/gift-message - name: guest-carts/{cartId}/gift-message/{itemId} - name: guest-carts/{cartId}/items - name: guest-carts/{cartId}/items/{itemId} - name: guest-carts/{cartId}/order - name: guest-carts/{cartId}/payment-information - name: guest-carts/{cartId}/payment-methods - name: guest-carts/{cartId}/selected-payment-method - name: guest-carts/{cartId}/set-payment-information - name: guest-carts/{cartId}/shipping-information - name: guest-carts/{cartId}/shipping-methods - name: guest-carts/{cartId}/totals - name: guest-carts/{cartId}/totals-information - name: guest-giftregistry/{cartId}/estimate-shipping-methods - name: integration/admin/token - name: integration/customer/revoke-customer-token - name: integration/customer/token - name: inventory/in-store-pickup/pickup-locations/ - name: negotiable-carts/{cartId}/billing-address - name: negotiable-carts/{cartId}/coupons - name: negotiable-carts/{cartId}/coupons/{couponCode} - name: negotiable-carts/{cartId}/estimate-shipping-methods - name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - name: negotiable-carts/{cartId}/giftCards - name: negotiable-carts/{cartId}/giftCards/{giftCardCode} - name: negotiable-carts/{cartId}/payment-information - name: negotiable-carts/{cartId}/set-payment-information - name: negotiable-carts/{cartId}/shipping-information - name: negotiable-carts/{cartId}/totals - name: products-render-info - name: purchase-order-carts/{cartId}/payment-information - name: purchase-order-carts/{cartId}/set-payment-information - name: quick-checkout/account-details - name: quick-checkout/has-account - name: quick-checkout/storefront/has-account - name: requisition_lists - name: reward/mine/use-reward - name: search - name: tfa/provider/authy/activate - name: tfa/provider/authy/authenticate - name: tfa/provider/authy/authenticate-onetouch - name: tfa/provider/authy/configure - name: tfa/provider/authy/send-token/{via} - name: tfa/provider/duo_security/activate - name: tfa/provider/duo_security/authenticate - name: tfa/provider/duo_security/configure - name: tfa/provider/duo_security/get-authentication-data - name: tfa/provider/google/activate - name: tfa/provider/google/authenticate - name: tfa/provider/google/configure - name: tfa/provider/u2fkey/activate - name: tfa/provider/u2fkey/authentication-challenge - name: tfa/provider/u2fkey/configure - name: tfa/provider/u2fkey/verify - name: tfa/tfat-providers-to-activate - name: tfa/tfat-user-providers paths: /V1/applepay/auth: get: tags: - applepay/auth description: Returns details required to be able to submit a payment with apple pay. operationId: GetV1ApplepayAuth consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: $ref: "#/definitions/pay-pal-braintree-data-auth-data-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: applepay/auth "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": get: tags: - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} description: Check gift card balance if added to the cart. operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: giftCardCode in: path type: string required: true responses: "200": description: 200 Success. schema: type: number "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} "/V1/carts/guest-carts/{cartId}/giftCards": post: tags: - carts/guest-carts/{cartId}/giftCards description: Add gift card to the cart. operationId: PostV1CartsGuestcartsCartIdGiftCards consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1CartsGuestcartsCartIdGiftCardsBody in: body schema: required: - giftCardAccountData properties: giftCardAccountData: $ref: "#/definitions/gift-card-account-data-gift-card-account-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/guest-carts/{cartId}/giftCards "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": delete: tags: - carts/guest-carts/{cartId}/giftCards/{giftCardCode} description: Remove GiftCard Account entity. operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: giftCardCode in: path type: string required: true responses: "200": description: 200 Success. schema: type: boolean default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} /V1/carts/mine: put: tags: - carts/mine description: Save quote operationId: PutV1CartsMine consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PutV1CartsMineBody in: body schema: required: - quote properties: quote: $ref: "#/definitions/quote-data-cart-interface" type: object xml: name: request responses: "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine get: tags: - carts/mine description: Returns information for the cart for a specified customer. operationId: GetV1CartsMine consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-cart-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine /V1/carts/mine/balance/apply: post: tags: - carts/mine/balance/apply description: Apply store credit operationId: PostV1CartsMineBalanceApply consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/balance/apply "/V1/carts/mine/checkGiftCard/{giftCardCode}": get: tags: - carts/mine/checkGiftCard/{giftCardCode} description: Check gift card balance if applied to given cart. operationId: GetV1CartsMineCheckGiftCardGiftCardCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: giftCardCode in: path type: string required: true responses: "200": description: 200 Success. schema: type: number "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/checkGiftCard/{giftCardCode} /V1/carts/mine/collect-totals: put: tags: - carts/mine/collect-totals description: Set shipping/billing methods and additional data for cart and collect totals. operationId: PutV1CartsMineCollecttotals consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PutV1CartsMineCollecttotalsBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" shippingCarrierCode: type: string description: The carrier code. shippingMethodCode: type: string description: The shipping method code. additionalData: $ref: "#/definitions/quote-data-totals-additional-data-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-totals-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/collect-totals /V1/carts/mine/payment-information: post: tags: - carts/mine/payment-information description: Set payment information and place order for a specified cart. operationId: PostV1CartsMinePaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CartsMinePaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/payment-information get: tags: - carts/mine/payment-information description: Get payment information operationId: GetV1CartsMinePaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/payment-information /V1/carts/mine/po-payment-information: post: tags: - carts/mine/po-payment-information description: Set payment information and place purchase order for a specified cart. operationId: PostV1CartsMinePopaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CartsMinePopaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Purchase Order ID. "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/po-payment-information /V1/carts/mine/set-payment-information: post: tags: - carts/mine/set-payment-information description: Set payment information for a specified cart. operationId: PostV1CartsMineSetpaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CartsMineSetpaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: carts/mine/set-payment-information /V1/customers: post: tags: - customers description: Create customer account. Perform necessary business operations like sending email. operationId: PostV1Customers consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CustomersBody in: body schema: required: - customer properties: customer: $ref: "#/definitions/customer-data-customer-interface" password: type: string redirectUrl: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/customer-data-customer-interface" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers /V1/customers/isEmailAvailable: post: tags: - customers/isEmailAvailable description: Check if given email is associated with a customer account in given website. operationId: PostV1CustomersIsEmailAvailable consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CustomersIsEmailAvailableBody in: body schema: required: - customerEmail properties: customerEmail: type: string websiteId: type: integer description: If not set, will use the current websiteId type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/isEmailAvailable /V1/customers/me/activate: put: tags: - customers/me/activate description: Activate a customer account using a key that was sent in a confirmation email. operationId: PutV1CustomersMeActivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PutV1CustomersMeActivateBody in: body schema: required: - confirmationKey properties: confirmationKey: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/customer-data-customer-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/me/activate /V1/customers/me/password: put: tags: - customers/me/password description: Change customer password. operationId: PutV1CustomersMePassword consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PutV1CustomersMePasswordBody in: body schema: required: - currentPassword - newPassword properties: currentPassword: type: string newPassword: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean description: true on success "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/me/password /V1/customers/password: put: tags: - customers/password description: Send an email to the customer with a password reset link. operationId: PutV1CustomersPassword consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PutV1CustomersPasswordBody in: body schema: required: - email - template properties: email: type: string template: type: string websiteId: type: integer type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean description: true on success "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/password /V1/customers/resetPassword: post: tags: - customers/resetPassword description: Reset customer password. operationId: PostV1CustomersResetPassword consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1CustomersResetPasswordBody in: body schema: required: - email - resetToken - newPassword properties: email: type: string description: If empty value given then the customer will be matched by the RP token. resetToken: type: string newPassword: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean description: true on success "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/resetPassword "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": get: tags: - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} description: Check if password reset token is valid. operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: customerId in: path type: integer required: true description: If null is given then a customer will be matched by the RP token. - name: resetPasswordLinkToken in: path type: string required: true responses: "200": description: 200 Success. schema: type: boolean description: True if the token is valid "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} /V1/directory/countries: get: tags: - directory/countries description: Get all countries and regions information for the store. operationId: GetV1DirectoryCountries consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: type: array items: $ref: "#/definitions/directory-data-country-information-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: directory/countries "/V1/directory/countries/{countryId}": get: tags: - directory/countries/{countryId} description: Get country and region information for the store. operationId: GetV1DirectoryCountriesCountryId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: countryId in: path type: string required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/directory-data-country-information-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: directory/countries/{countryId} /V1/directory/currency: get: tags: - directory/currency description: Get currency information for the store. operationId: GetV1DirectoryCurrency consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: $ref: "#/definitions/directory-data-currency-information-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: directory/currency /V1/giftregistry/mine/estimate-shipping-methods: post: tags: - giftregistry/mine/estimate-shipping-methods description: Estimate shipping operationId: PostV1GiftregistryMineEstimateshippingmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1GiftregistryMineEstimateshippingmethodsBody in: body schema: required: - registryId properties: registryId: type: integer description: The estimate registry id type: object xml: name: request responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods. items: $ref: "#/definitions/quote-data-shipping-method-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: giftregistry/mine/estimate-shipping-methods /V1/guest-carts: post: tags: - guest-carts description: Enable an customer or guest user to create an empty cart and quote for an anonymous customer. operationId: PostV1Guestcarts consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: type: string description: Cart ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts "/V1/guest-carts/{cartId}": get: tags: - guest-carts/{cartId} description: Enable a guest user to return information for a specified cart. operationId: GetV1GuestcartsCartId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-cart-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId} put: tags: - guest-carts/{cartId} description: Assign a specified customer to a specified shopping cart. operationId: PutV1GuestcartsCartId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PutV1GuestcartsCartIdBody in: body schema: required: - customerId - storeId properties: customerId: type: integer description: The customer ID. storeId: type: integer type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId} "/V1/guest-carts/{cartId}/billing-address": get: tags: - guest-carts/{cartId}/billing-address description: Return the billing address for a specified quote. operationId: GetV1GuestcartsCartIdBillingaddress consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-address-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/billing-address post: tags: - guest-carts/{cartId}/billing-address description: Assign a specified billing address to a specified cart. operationId: PostV1GuestcartsCartIdBillingaddress consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PostV1GuestcartsCartIdBillingaddressBody in: body schema: required: - address properties: address: $ref: "#/definitions/quote-data-address-interface" useForShipping: type: boolean type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Address ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/billing-address "/V1/guest-carts/{cartId}/collect-totals": put: tags: - guest-carts/{cartId}/collect-totals description: Set shipping/billing methods and additional data for cart and collect totals for guest. operationId: PutV1GuestcartsCartIdCollecttotals consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PutV1GuestcartsCartIdCollecttotalsBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" shippingCarrierCode: type: string description: The carrier code. shippingMethodCode: type: string description: The shipping method code. additionalData: $ref: "#/definitions/quote-data-totals-additional-data-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-totals-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/collect-totals "/V1/guest-carts/{cartId}/coupons": get: tags: - guest-carts/{cartId}/coupons description: Return information for a coupon in a specified cart. operationId: GetV1GuestcartsCartIdCoupons consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: type: string description: The coupon code data. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/coupons delete: tags: - guest-carts/{cartId}/coupons description: Delete a coupon from a specified cart. operationId: DeleteV1GuestcartsCartIdCoupons consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/coupons "/V1/guest-carts/{cartId}/coupons/{couponCode}": put: tags: - guest-carts/{cartId}/coupons/{couponCode} description: Add a coupon by code to a specified cart. operationId: PutV1GuestcartsCartIdCouponsCouponCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: couponCode in: path type: string required: true description: The coupon code data. responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/coupons/{couponCode} "/V1/guest-carts/{cartId}/estimate-shipping-methods": post: tags: - guest-carts/{cartId}/estimate-shipping-methods description: Estimate shipping by address and return list of available shipping methods operationId: PostV1GuestcartsCartIdEstimateshippingmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody in: body schema: required: - address properties: address: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods items: $ref: "#/definitions/quote-data-shipping-method-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/estimate-shipping-methods "/V1/guest-carts/{cartId}/gift-message": get: tags: - guest-carts/{cartId}/gift-message description: Return the gift message for a specified order. operationId: GetV1GuestcartsCartIdGiftmessage consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The shopping cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/gift-message-data-message-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/gift-message post: tags: - guest-carts/{cartId}/gift-message description: Set the gift message for an entire order. operationId: PostV1GuestcartsCartIdGiftmessage consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PostV1GuestcartsCartIdGiftmessageBody in: body schema: required: - giftMessage properties: giftMessage: $ref: "#/definitions/gift-message-data-message-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/gift-message "/V1/guest-carts/{cartId}/gift-message/{itemId}": get: tags: - guest-carts/{cartId}/gift-message/{itemId} description: Return the gift message for a specified item in a specified shopping cart. operationId: GetV1GuestcartsCartIdGiftmessageItemId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The shopping cart ID. - name: itemId in: path type: integer required: true description: The item ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/gift-message-data-message-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/gift-message/{itemId} post: tags: - guest-carts/{cartId}/gift-message/{itemId} description: Set the gift message for a specified item in a specified shopping cart. operationId: PostV1GuestcartsCartIdGiftmessageItemId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: itemId in: path type: integer required: true description: The item ID. - name: PostV1GuestcartsCartIdGiftmessageItemIdBody in: body schema: required: - giftMessage properties: giftMessage: $ref: "#/definitions/gift-message-data-message-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/gift-message/{itemId} "/V1/guest-carts/{cartId}/items": get: tags: - guest-carts/{cartId}/items description: List items that are assigned to a specified cart. operationId: GetV1GuestcartsCartIdItems consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: type: array description: Array of items. items: $ref: "#/definitions/quote-data-cart-item-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/items post: tags: - guest-carts/{cartId}/items description: Add/update the specified cart item. operationId: PostV1GuestcartsCartIdItems consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdItemsBody in: body schema: required: - cartItem properties: cartItem: $ref: "#/definitions/quote-data-cart-item-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-cart-item-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/items "/V1/guest-carts/{cartId}/items/{itemId}": put: tags: - guest-carts/{cartId}/items/{itemId} description: Add/update the specified cart item. operationId: PutV1GuestcartsCartIdItemsItemId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: itemId in: path type: string required: true - name: PutV1GuestcartsCartIdItemsItemIdBody in: body schema: required: - cartItem properties: cartItem: $ref: "#/definitions/quote-data-cart-item-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-cart-item-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/items/{itemId} delete: tags: - guest-carts/{cartId}/items/{itemId} description: Remove the specified item from the specified cart. operationId: DeleteV1GuestcartsCartIdItemsItemId consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: itemId in: path type: integer required: true description: The item ID of the item to be removed. responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/items/{itemId} "/V1/guest-carts/{cartId}/order": put: tags: - guest-carts/{cartId}/order description: Place an order for a specified cart. operationId: PutV1GuestcartsCartIdOrder consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PutV1GuestcartsCartIdOrderBody in: body schema: properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/order "/V1/guest-carts/{cartId}/payment-information": post: tags: - guest-carts/{cartId}/payment-information description: Set payment information and place order for a specified cart. operationId: PostV1GuestcartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdPaymentinformationBody in: body schema: required: - email - paymentMethod properties: email: type: string paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/payment-information get: tags: - guest-carts/{cartId}/payment-information description: Get payment information operationId: GetV1GuestcartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/payment-information "/V1/guest-carts/{cartId}/payment-methods": get: tags: - guest-carts/{cartId}/payment-methods description: List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object. operationId: GetV1GuestcartsCartIdPaymentmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: type: array description: Array of payment methods. items: $ref: "#/definitions/quote-data-payment-method-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/payment-methods "/V1/guest-carts/{cartId}/selected-payment-method": get: tags: - guest-carts/{cartId}/selected-payment-method description: Return the payment method for a specified shopping cart. operationId: GetV1GuestcartsCartIdSelectedpaymentmethod consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-payment-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/selected-payment-method put: tags: - guest-carts/{cartId}/selected-payment-method description: Add a specified payment method to a specified shopping cart. operationId: PutV1GuestcartsCartIdSelectedpaymentmethod consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody in: body schema: required: - method properties: method: $ref: "#/definitions/quote-data-payment-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Payment method ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/selected-payment-method "/V1/guest-carts/{cartId}/set-payment-information": post: tags: - guest-carts/{cartId}/set-payment-information description: Set payment information for a specified cart. operationId: PostV1GuestcartsCartIdSetpaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdSetpaymentinformationBody in: body schema: required: - email - paymentMethod properties: email: type: string paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/set-payment-information "/V1/guest-carts/{cartId}/shipping-information": post: tags: - guest-carts/{cartId}/shipping-information description: "" operationId: PostV1GuestcartsCartIdShippinginformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdShippinginformationBody in: body schema: required: - addressInformation properties: addressInformation: $ref: "#/definitions/checkout-data-shipping-information-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/shipping-information "/V1/guest-carts/{cartId}/shipping-methods": get: tags: - guest-carts/{cartId}/shipping-methods description: List applicable shipping methods for a specified quote. operationId: GetV1GuestcartsCartIdShippingmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The shopping cart ID. responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods. items: $ref: "#/definitions/quote-data-shipping-method-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/shipping-methods "/V1/guest-carts/{cartId}/totals": get: tags: - guest-carts/{cartId}/totals description: Return quote totals data for a specified cart. operationId: GetV1GuestcartsCartIdTotals consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-totals-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/totals "/V1/guest-carts/{cartId}/totals-information": post: tags: - guest-carts/{cartId}/totals-information description: Calculate quote totals based on address and shipping method. operationId: PostV1GuestcartsCartIdTotalsinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1GuestcartsCartIdTotalsinformationBody in: body schema: required: - addressInformation properties: addressInformation: $ref: "#/definitions/checkout-data-totals-information-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-totals-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-carts/{cartId}/totals-information "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": post: tags: - guest-giftregistry/{cartId}/estimate-shipping-methods description: Estimate shipping operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true description: The shopping cart ID. - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody in: body schema: required: - registryId properties: registryId: type: integer description: The estimate registry id type: object xml: name: request responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods. items: $ref: "#/definitions/quote-data-shipping-method-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: guest-giftregistry/{cartId}/estimate-shipping-methods /V1/integration/admin/token: post: tags: - integration/admin/token description: Create access token for admin given the admin credentials. operationId: PostV1IntegrationAdminToken consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1IntegrationAdminTokenBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string description: Token created "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: integration/admin/token /V1/integration/customer/revoke-customer-token: post: tags: - integration/customer/revoke-customer-token description: Revoke token by customer id. operationId: PostV1IntegrationCustomerRevokecustomertoken consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: integration/customer/revoke-customer-token /V1/integration/customer/token: post: tags: - integration/customer/token description: Create access token for admin given the customer credentials. operationId: PostV1IntegrationCustomerToken consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1IntegrationCustomerTokenBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string description: Token created "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: integration/customer/token /V1/inventory/in-store-pickup/pickup-locations/: get: tags: - inventory/in-store-pickup/pickup-locations/ description: Get Pickup Locations according to the results of filtration by Search Request. operationId: GetV1InventoryInstorepickupPickuplocations consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: searchRequest[area][radius] in: query type: integer description: Search radius in KM. - name: searchRequest[area][searchTerm] in: query type: string description: Search term string. - name: searchRequest[filters][country][value] in: query type: string description: Value. - name: searchRequest[filters][country][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][postcode][value] in: query type: string description: Value. - name: searchRequest[filters][postcode][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][region][value] in: query type: string description: Value. - name: searchRequest[filters][region][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][regionId][value] in: query type: string description: Value. - name: searchRequest[filters][regionId][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][city][value] in: query type: string description: Value. - name: searchRequest[filters][city][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][street][value] in: query type: string description: Value. - name: searchRequest[filters][street][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][name][value] in: query type: string description: Value. - name: searchRequest[filters][name][conditionType] in: query type: string description: Condition Type. - name: searchRequest[filters][pickupLocationCode][value] in: query type: string description: Value. - name: searchRequest[filters][pickupLocationCode][conditionType] in: query type: string description: Condition Type. - name: searchRequest[pageSize] in: query type: integer description: Page size. - name: searchRequest[currentPage] in: query type: integer description: Current page. - name: searchRequest[scopeType] in: query type: string description: Sales Channel Type. - name: searchRequest[scopeCode] in: query type: string description: Sales Channel code. - name: searchRequest[sort][0][field] in: query type: string description: Sorting field. - name: searchRequest[sort][0][direction] in: query type: string description: Sorting direction. - name: searchRequest[extensionAttributes][productsInfo][0][sku] in: query type: string description: Product SKU. responses: "200": description: 200 Success. schema: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: inventory/in-store-pickup/pickup-locations/ "/V1/negotiable-carts/{cartId}/billing-address": get: tags: - negotiable-carts/{cartId}/billing-address description: Returns the billing address for a specified quote. operationId: GetV1NegotiablecartsCartIdBillingaddress consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-address-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/billing-address post: tags: - negotiable-carts/{cartId}/billing-address description: Assigns a specified billing address to a specified cart. operationId: PostV1NegotiablecartsCartIdBillingaddress consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The cart ID. - name: PostV1NegotiablecartsCartIdBillingaddressBody in: body schema: required: - address properties: address: $ref: "#/definitions/quote-data-address-interface" useForShipping: type: boolean type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Address ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/billing-address "/V1/negotiable-carts/{cartId}/coupons": delete: tags: - negotiable-carts/{cartId}/coupons description: Deletes a coupon from a specified cart. operationId: DeleteV1NegotiablecartsCartIdCoupons consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The cart ID. responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/coupons "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": put: tags: - negotiable-carts/{cartId}/coupons/{couponCode} description: Adds a coupon by code to a specified cart. operationId: PutV1NegotiablecartsCartIdCouponsCouponCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The cart ID. - name: couponCode in: path type: string required: true description: The coupon code data. responses: "200": description: 200 Success. schema: type: boolean "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/coupons/{couponCode} "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": post: tags: - negotiable-carts/{cartId}/estimate-shipping-methods description: Estimate shipping by address and return list of available shipping methods operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody in: body schema: required: - address properties: address: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods items: $ref: "#/definitions/quote-data-shipping-method-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/estimate-shipping-methods "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": post: tags: - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id description: Estimate shipping operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The shopping cart ID. - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody in: body schema: required: - addressId properties: addressId: type: integer description: The estimate address id type: object xml: name: request responses: "200": description: 200 Success. schema: type: array description: An array of shipping methods. items: $ref: "#/definitions/quote-data-shipping-method-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id "/V1/negotiable-carts/{cartId}/giftCards": post: tags: - negotiable-carts/{cartId}/giftCards description: "" operationId: PostV1NegotiablecartsCartIdGiftCards consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: PostV1NegotiablecartsCartIdGiftCardsBody in: body schema: required: - giftCardAccountData properties: giftCardAccountData: $ref: "#/definitions/gift-card-account-data-gift-card-account-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/giftCards "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": delete: tags: - negotiable-carts/{cartId}/giftCards/{giftCardCode} description: Remove GiftCard Account entity operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: giftCardCode in: path type: string required: true responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/giftCards/{giftCardCode} "/V1/negotiable-carts/{cartId}/payment-information": post: tags: - negotiable-carts/{cartId}/payment-information description: Set payment information and place order for a specified cart. operationId: PostV1NegotiablecartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: string required: true - name: PostV1NegotiablecartsCartIdPaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/payment-information get: tags: - negotiable-carts/{cartId}/payment-information description: Get payment information operationId: GetV1NegotiablecartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/payment-information "/V1/negotiable-carts/{cartId}/set-payment-information": post: tags: - negotiable-carts/{cartId}/set-payment-information description: Set payment information for a specified cart. operationId: PostV1NegotiablecartsCartIdSetpaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/set-payment-information "/V1/negotiable-carts/{cartId}/shipping-information": post: tags: - negotiable-carts/{cartId}/shipping-information description: "" operationId: PostV1NegotiablecartsCartIdShippinginformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: PostV1NegotiablecartsCartIdShippinginformationBody in: body schema: required: - addressInformation properties: addressInformation: $ref: "#/definitions/checkout-data-shipping-information-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/shipping-information "/V1/negotiable-carts/{cartId}/totals": get: tags: - negotiable-carts/{cartId}/totals description: Returns quote totals data for a specified cart. operationId: GetV1NegotiablecartsCartIdTotals consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true description: The cart ID. responses: "200": description: 200 Success. schema: $ref: "#/definitions/quote-data-totals-interface" "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: negotiable-carts/{cartId}/totals /V1/products-render-info: get: tags: - products-render-info description: Collect and retrieve the list of product render info. This info contains raw prices and formatted prices, product name, stock status, store_id, etc. operationId: GetV1Productsrenderinfo consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: searchCriteria[filterGroups][0][filters][0][field] in: query type: string description: Field - name: searchCriteria[filterGroups][0][filters][0][value] in: query type: string description: Value - name: searchCriteria[filterGroups][0][filters][0][conditionType] in: query type: string description: Condition type - name: searchCriteria[sortOrders][0][field] in: query type: string description: Sorting field. - name: searchCriteria[sortOrders][0][direction] in: query type: string description: Sorting direction. - name: searchCriteria[pageSize] in: query type: integer description: Page size. - name: searchCriteria[currentPage] in: query type: integer description: Current page. - name: storeId in: query type: integer required: true - name: currencyCode in: query type: string required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/catalog-data-product-render-search-results-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: products-render-info "/V1/purchase-order-carts/{cartId}/payment-information": post: tags: - purchase-order-carts/{cartId}/payment-information description: Set payment information and place order for a specified cart. operationId: PostV1PurchaseordercartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: PostV1PurchaseordercartsCartIdPaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: purchase-order-carts/{cartId}/payment-information get: tags: - purchase-order-carts/{cartId}/payment-information description: Get payment information operationId: GetV1PurchaseordercartsCartIdPaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true responses: "200": description: 200 Success. schema: $ref: "#/definitions/checkout-data-payment-details-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: purchase-order-carts/{cartId}/payment-information "/V1/purchase-order-carts/{cartId}/set-payment-information": post: tags: - purchase-order-carts/{cartId}/set-payment-information description: Set payment information for a specified cart. operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: cartId in: path type: integer required: true - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody in: body schema: required: - paymentMethod properties: paymentMethod: $ref: "#/definitions/quote-data-payment-interface" billingAddress: $ref: "#/definitions/quote-data-address-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: type: integer description: Order ID. "400": description: 400 Bad Request schema: $ref: "#/definitions/error-response" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: purchase-order-carts/{cartId}/set-payment-information /V1/quick-checkout/account-details: post: tags: - quick-checkout/account-details description: Retrieve account information operationId: PostV1QuickcheckoutAccountdetails consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: $ref: "#/definitions/quick-checkout-data-account-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: quick-checkout/account-details /V1/quick-checkout/has-account: post: tags: - quick-checkout/has-account description: Check if email exists in Bolt operationId: PostV1QuickcheckoutHasaccount consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1QuickcheckoutHasaccountBody in: body schema: required: - email properties: email: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: quick-checkout/has-account /V1/quick-checkout/storefront/has-account: post: tags: - quick-checkout/storefront/has-account description: Check if email exists in Storefront operationId: PostV1QuickcheckoutStorefrontHasaccount consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1QuickcheckoutStorefrontHasaccountBody in: body schema: required: - email properties: email: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: boolean "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: quick-checkout/storefront/has-account /V1/requisition_lists: post: tags: - requisition_lists description: Save Requisition List operationId: PostV1Requisition_lists consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1Requisition_listsBody in: body schema: required: - requisitionList properties: requisitionList: $ref: "#/definitions/requisition-list-data-requisition-list-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/requisition-list-data-requisition-list-interface" "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" "500": description: Internal Server error schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: requisition_lists /V1/reward/mine/use-reward: post: tags: - reward/mine/use-reward description: Set reward points to quote operationId: PostV1RewardMineUsereward consumes: - application/json - application/xml produces: - application/json - application/xml responses: "200": description: 200 Success. schema: type: boolean "401": description: 401 Unauthorized schema: $ref: "#/definitions/error-response" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: reward/mine/use-reward /V1/search: get: tags: - search description: Make Full Text Search and return found Documents operationId: GetV1Search consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: searchCriteria[requestName] in: query type: string - name: searchCriteria[filterGroups][0][filters][0][field] in: query type: string description: Field - name: searchCriteria[filterGroups][0][filters][0][value] in: query type: string description: Value - name: searchCriteria[filterGroups][0][filters][0][conditionType] in: query type: string description: Condition type - name: searchCriteria[sortOrders][0][field] in: query type: string description: Sorting field. - name: searchCriteria[sortOrders][0][direction] in: query type: string description: Sorting direction. - name: searchCriteria[pageSize] in: query type: integer description: Page size. - name: searchCriteria[currentPage] in: query type: integer description: Current page. responses: "200": description: 200 Success. schema: $ref: "#/definitions/framework-search-search-result-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: search /V1/tfa/provider/authy/activate: post: tags: - tfa/provider/authy/activate description: Activate the provider and get an admin token operationId: PostV1TfaProviderAuthyActivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderAuthyActivateBody in: body schema: required: - tfaToken - otp properties: tfaToken: type: string otp: type: string type: object xml: name: request responses: default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/authy/activate /V1/tfa/provider/authy/authenticate: post: tags: - tfa/provider/authy/authenticate description: Get an admin token using authy 2fa operationId: PostV1TfaProviderAuthyAuthenticate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderAuthyAuthenticateBody in: body schema: required: - username - password - otp properties: username: type: string password: type: string otp: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string description: $otp default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/authy/authenticate /V1/tfa/provider/authy/authenticate-onetouch: post: tags: - tfa/provider/authy/authenticate-onetouch description: Authenticate using the present one touch response and get an admin token operationId: PostV1TfaProviderAuthyAuthenticateonetouch consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderAuthyAuthenticateonetouchBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/authy/authenticate-onetouch /V1/tfa/provider/authy/configure: post: tags: - tfa/provider/authy/configure description: Get the information required to configure google operationId: PostV1TfaProviderAuthyConfigure consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderAuthyConfigureBody in: body schema: required: - tfaToken - deviceData properties: tfaToken: type: string deviceData: $ref: "#/definitions/two-factor-auth-data-authy-device-interface" type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-authy-registration-prompt-response-in\ terface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/authy/configure "/V1/tfa/provider/authy/send-token/{via}": post: tags: - tfa/provider/authy/send-token/{via} description: Send a one time password to a device using authy operationId: PostV1TfaProviderAuthySendtokenVia consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: via in: path type: string required: true - name: PostV1TfaProviderAuthySendtokenViaBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/authy/send-token/{via} /V1/tfa/provider/duo_security/activate: post: tags: - tfa/provider/duo_security/activate description: Activate the provider and get an admin token operationId: PostV1TfaProviderDuo_securityActivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderDuo_securityActivateBody in: body schema: required: - tfaToken - signatureResponse properties: tfaToken: type: string signatureResponse: type: string type: object xml: name: request responses: default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/duo_security/activate /V1/tfa/provider/duo_security/authenticate: post: tags: - tfa/provider/duo_security/authenticate description: Authenticate and get an admin token operationId: PostV1TfaProviderDuo_securityAuthenticate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderDuo_securityAuthenticateBody in: body schema: required: - username - password - signatureResponse properties: username: type: string password: type: string signatureResponse: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/duo_security/authenticate /V1/tfa/provider/duo_security/configure: post: tags: - tfa/provider/duo_security/configure description: Get the information required to configure duo operationId: PostV1TfaProviderDuo_securityConfigure consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderDuo_securityConfigureBody in: body schema: required: - tfaToken properties: tfaToken: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-duo-data-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/duo_security/configure /V1/tfa/provider/duo_security/get-authentication-data: post: tags: - tfa/provider/duo_security/get-authentication-data description: Get the information required to configure duo operationId: PostV1TfaProviderDuo_securityGetauthenticationdata consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderDuo_securityGetauthenticationdataBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-duo-data-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/duo_security/get-authentication-data /V1/tfa/provider/google/activate: post: tags: - tfa/provider/google/activate description: Activate the provider and get an admin token operationId: PostV1TfaProviderGoogleActivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderGoogleActivateBody in: body schema: required: - tfaToken - otp properties: tfaToken: type: string otp: type: string type: object xml: name: request responses: default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/google/activate /V1/tfa/provider/google/authenticate: post: tags: - tfa/provider/google/authenticate description: Get an admin token by authenticating using google operationId: PostV1TfaProviderGoogleAuthenticate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderGoogleAuthenticateBody in: body schema: required: - username - password - otp properties: username: type: string password: type: string otp: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/google/authenticate /V1/tfa/provider/google/configure: post: tags: - tfa/provider/google/configure description: Get the information required to configure google operationId: PostV1TfaProviderGoogleConfigure consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderGoogleConfigureBody in: body schema: required: - tfaToken properties: tfaToken: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-google-configure-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/google/configure /V1/tfa/provider/u2fkey/activate: post: tags: - tfa/provider/u2fkey/activate description: Activate the provider and get a token operationId: PostV1TfaProviderU2fkeyActivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderU2fkeyActivateBody in: body schema: required: - tfaToken - publicKeyCredentialJson properties: tfaToken: type: string publicKeyCredentialJson: type: string type: object xml: name: request responses: default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/u2fkey/activate /V1/tfa/provider/u2fkey/authentication-challenge: post: tags: - tfa/provider/u2fkey/authentication-challenge description: Get the information to initiate a WebAuthn registration ceremony operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody in: body schema: required: - username - password properties: username: type: string password: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/u2fkey/authentication-challenge /V1/tfa/provider/u2fkey/configure: post: tags: - tfa/provider/u2fkey/configure description: Get the information to initiate a WebAuthn registration ceremony operationId: PostV1TfaProviderU2fkeyConfigure consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderU2fkeyConfigureBody in: body schema: required: - tfaToken properties: tfaToken: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: $ref: "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/u2fkey/configure /V1/tfa/provider/u2fkey/verify: post: tags: - tfa/provider/u2fkey/verify description: Authenticate with the provider and get a token operationId: PostV1TfaProviderU2fkeyVerify consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: PostV1TfaProviderU2fkeyVerifyBody in: body schema: required: - username - password - publicKeyCredentialJson properties: username: type: string password: type: string publicKeyCredentialJson: type: string type: object xml: name: request responses: "200": description: 200 Success. schema: type: string default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/provider/u2fkey/verify /V1/tfa/tfat-providers-to-activate: get: tags: - tfa/tfat-providers-to-activate description: Get the providers that the user still needs to configure operationId: GetV1TfaTfatproviderstoactivate consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: tfaToken in: query type: string required: true responses: "200": description: 200 Success. schema: type: array items: $ref: "#/definitions/two-factor-auth-provider-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/tfat-providers-to-activate /V1/tfa/tfat-user-providers: get: tags: - tfa/tfat-user-providers description: Get the providers that the user is able to use for 2fa operationId: GetV1TfaTfatuserproviders consumes: - application/json - application/xml produces: - application/json - application/xml parameters: - name: tfaToken in: query type: string required: true responses: "200": description: 200 Success. schema: type: array items: $ref: "#/definitions/two-factor-auth-provider-interface" default: description: Unexpected error schema: $ref: "#/definitions/error-response" summary: tfa/tfat-user-providers definitions: error-response: type: object properties: message: type: string description: Error message errors: $ref: "#/definitions/error-errors" code: type: integer description: Error code parameters: $ref: "#/definitions/error-parameters" trace: type: string description: Stack trace required: - message error-errors: type: array description: Errors list items: $ref: "#/definitions/error-errors-item" error-errors-item: type: object description: Error details properties: message: type: string description: Error message parameters: $ref: "#/definitions/error-parameters" error-parameters: type: array description: Error parameters list items: $ref: "#/definitions/error-parameters-item" error-parameters-item: type: object description: Error parameters item properties: resources: type: string description: ACL resource fieldName: type: string description: Missing or invalid field name fieldValue: type: string description: Incorrect field value directory-data-currency-information-interface: type: object description: Currency Information interface. properties: base_currency_code: type: string description: The base currency code for the store. base_currency_symbol: type: string description: The currency symbol of the base currency for the store. default_display_currency_code: type: string description: The default display currency code for the store. default_display_currency_symbol: type: string description: The currency symbol of the default display currency for the store. available_currency_codes: type: array description: The list of allowed currency codes for the store. items: type: string exchange_rates: type: array description: The list of exchange rate information for the store. items: $ref: "#/definitions/directory-data-exchange-rate-interface" extension_attributes: $ref: "#/definitions/directory-data-currency-information-extension-interface" required: - base_currency_code - base_currency_symbol - default_display_currency_code - default_display_currency_symbol - available_currency_codes - exchange_rates directory-data-exchange-rate-interface: type: object description: Exchange Rate interface. properties: currency_to: type: string description: The currency code associated with the exchange rate. rate: type: number description: The exchange rate for the associated currency and the store's base currency. extension_attributes: $ref: "#/definitions/directory-data-exchange-rate-extension-interface" required: - currency_to - rate directory-data-exchange-rate-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface directory-data-currency-information-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface directory-data-country-information-interface: type: object description: Country Information interface. properties: id: type: string description: The country id for the store. two_letter_abbreviation: type: string description: The country 2 letter abbreviation for the store. three_letter_abbreviation: type: string description: The country 3 letter abbreviation for the store. full_name_locale: type: string description: The country full name (in store locale) for the store. full_name_english: type: string description: The country full name (in English) for the store. available_regions: type: array description: The available regions for the store. items: $ref: "#/definitions/directory-data-region-information-interface" extension_attributes: $ref: "#/definitions/directory-data-country-information-extension-interface" required: - id - two_letter_abbreviation - three_letter_abbreviation - full_name_locale - full_name_english directory-data-region-information-interface: type: object description: Region Information interface. properties: id: type: string description: Region id code: type: string description: Region code name: type: string description: Region name extension_attributes: $ref: "#/definitions/directory-data-region-information-extension-interface" required: - id - code - name directory-data-region-information-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface directory-data-country-information-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface customer-data-customer-interface: type: object description: Customer entity interface for API handling. properties: id: type: integer description: Customer id group_id: type: integer description: Group id default_billing: type: string description: Default billing address id default_shipping: type: string description: Default shipping address id confirmation: type: string description: Confirmation created_at: type: string description: Created at time updated_at: type: string description: Updated at time created_in: type: string description: Created in area dob: type: string description: In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers (e.g., full name) before collecting or processing such data. email: type: string description: Email address firstname: type: string description: First name lastname: type: string description: Last name middlename: type: string description: Middle name prefix: type: string description: Prefix suffix: type: string description: Suffix gender: type: integer description: Gender store_id: type: integer description: Store id taxvat: type: string description: Tax Vat website_id: type: integer description: Website id addresses: type: array description: Customer addresses. items: $ref: "#/definitions/customer-data-address-interface" disable_auto_group_change: type: integer description: Disable auto group change flag. extension_attributes: $ref: "#/definitions/customer-data-customer-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" required: - email - firstname - lastname customer-data-address-interface: type: object description: Customer address interface. properties: id: type: integer description: ID customer_id: type: integer description: Customer ID region: $ref: "#/definitions/customer-data-region-interface" region_id: type: integer description: Region ID country_id: type: string description: Country code in ISO_3166-2 format street: type: array description: Street items: type: string company: type: string description: Company telephone: type: string description: Telephone number fax: type: string description: Fax number postcode: type: string description: Postcode city: type: string description: City name firstname: type: string description: First name lastname: type: string description: Last name middlename: type: string description: Middle name prefix: type: string description: Prefix suffix: type: string description: Suffix vat_id: type: string description: Vat id default_shipping: type: boolean description: If this address is default shipping address. default_billing: type: boolean description: If this address is default billing address extension_attributes: $ref: "#/definitions/customer-data-address-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" customer-data-region-interface: type: object description: Customer address region interface. properties: region_code: type: string description: Region code region: type: string description: Region region_id: type: integer description: Region id extension_attributes: $ref: "#/definitions/customer-data-region-extension-interface" required: - region_code - region - region_id customer-data-region-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface customer-data-address-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface framework-attribute-interface: type: object description: Interface for custom attribute value. properties: attribute_code: type: string description: Attribute code value: type: string description: Attribute value required: - attribute_code - value customer-data-customer-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface properties: company_attributes: $ref: "#/definitions/company-data-company-customer-interface" assistance_allowed: type: integer is_subscribed: type: boolean company-data-company-customer-interface: type: object description: Extended customer custom attributes interface. properties: customer_id: type: integer description: Customer ID. company_id: type: integer description: Company ID. job_title: type: string description: Get job title. status: type: integer description: Customer status. telephone: type: string description: Get telephone. extension_attributes: $ref: "#/definitions/company-data-company-customer-extension-interface" company-data-company-customer-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface catalog-data-product-render-search-results-interface: type: object description: Dto that holds render information about products properties: items: type: array description: List of products rendered information items: $ref: "#/definitions/catalog-data-product-render-interface" required: - items catalog-data-product-render-interface: type: object description: Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data properties: add_to_cart_button: $ref: "#/definitions/catalog-data-product-render-button-interface" add_to_compare_button: $ref: "#/definitions/catalog-data-product-render-button-interface" price_info: $ref: "#/definitions/catalog-data-product-render-price-info-interface" images: type: array description: Enough information, that needed to render image on front items: $ref: "#/definitions/catalog-data-product-render-image-interface" url: type: string description: Product url id: type: integer description: Product identifier name: type: string description: Product name type: type: string description: Product type. Such as bundle, grouped, simple, etc... is_salable: type: string description: Information about product saleability (In Stock) store_id: type: integer description: Information about current store id or requested store id currency_code: type: string description: Current or desired currency code to product extension_attributes: $ref: "#/definitions/catalog-data-product-render-extension-interface" required: - add_to_cart_button - add_to_compare_button - price_info - images - url - id - name - type - is_salable - store_id - currency_code - extension_attributes catalog-data-product-render-button-interface: type: object description: "Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend" properties: post_data: type: string description: Post data url: type: string description: Url, needed to add product to cart required_options: type: boolean description: Flag whether a product has options or not extension_attributes: $ref: "#/definitions/catalog-data-product-render-button-extension-interface" required: - post_data - url - required_options catalog-data-product-render-button-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface catalog-data-product-render-price-info-interface: type: object description: Price interface. properties: final_price: type: number description: Final price max_price: type: number description: Max price of a product max_regular_price: type: number description: Max regular price minimal_regular_price: type: number description: Minimal regular price special_price: type: number description: Special price minimal_price: type: number description: Minimal price regular_price: type: number description: Regular price formatted_prices: $ref: "#/definitions/catalog-data-product-render-formatted-price-info-interface" extension_attributes: $ref: "#/definitions/catalog-data-product-render-price-info-extension-interface" required: - final_price - max_price - max_regular_price - minimal_regular_price - special_price - minimal_price - regular_price - formatted_prices catalog-data-product-render-formatted-price-info-interface: type: object description: 'Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html' properties: final_price: type: string description: Html with final price max_price: type: string description: Max price of a product minimal_price: type: string description: The minimal price of the product or variation max_regular_price: type: string description: Max regular price minimal_regular_price: type: string description: Minimal regular price special_price: type: string description: Special price regular_price: type: string description: Price - is price of product without discounts and special price with taxes and fixed product tax extension_attributes: $ref: "#/definitions/catalog-data-product-render-formatted-price-info-extension\ -interface" required: - final_price - max_price - minimal_price - max_regular_price - minimal_regular_price - special_price - regular_price catalog-data-product-render-formatted-price-info-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface catalog-data-product-render-price-info-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface properties: msrp: $ref: "#/definitions/msrp-data-product-render-msrp-price-info-interface" tax_adjustments: $ref: "#/definitions/catalog-data-product-render-price-info-interface" weee_attributes: type: array items: $ref: "#/definitions/weee-data-product-render-weee-adjustment-attribute-interfa\ ce" weee_adjustment: type: string msrp-data-product-render-msrp-price-info-interface: type: object description: Price interface. properties: msrp_price: type: string is_applicable: type: string is_shown_price_on_gesture: type: string msrp_message: type: string explanation_message: type: string extension_attributes: $ref: "#/definitions/msrp-data-product-render-msrp-price-info-extension-interfa\ ce" required: - msrp_price - is_applicable - is_shown_price_on_gesture - msrp_message - explanation_message msrp-data-product-render-msrp-price-info-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface weee-data-product-render-weee-adjustment-attribute-interface: type: object description: List of all weee attributes, their amounts, etc.., that product has properties: amount: type: string description: Weee attribute amount tax_amount: type: string description: Tax which is calculated to fixed product tax attribute tax_amount_incl_tax: type: string description: Tax amount of weee attribute amount_excl_tax: type: string description: Product amount exclude tax attribute_code: type: string description: Weee attribute code extension_attributes: $ref: "#/definitions/weee-data-product-render-weee-adjustment-attribute-extensi\ on-interface" required: - amount - tax_amount - tax_amount_incl_tax - amount_excl_tax - attribute_code - extension_attributes weee-data-product-render-weee-adjustment-attribute-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface catalog-data-product-render-image-interface: type: object description: Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view properties: url: type: string description: Image url code: type: string description: Image code height: type: number description: Image height width: type: number description: Image width in px label: type: string description: Image label resized_width: type: number description: Resize width resized_height: type: number description: Resize height extension_attributes: $ref: "#/definitions/catalog-data-product-render-image-extension-interface" required: - url - code - height - width - label - resized_width - resized_height catalog-data-product-render-image-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface catalog-data-product-render-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface properties: wishlist_button: $ref: "#/definitions/catalog-data-product-render-button-interface" review_html: type: string quote-data-cart-interface: type: object description: Interface CartInterface properties: id: type: integer description: Cart/quote ID. created_at: type: string description: Cart creation date and time. Otherwise, null. updated_at: type: string description: Cart last update date and time. Otherwise, null. converted_at: type: string description: Cart conversion date and time. Otherwise, null. is_active: type: boolean description: Active status flag value. Otherwise, null. is_virtual: type: boolean description: Virtual flag value. Otherwise, null. items: type: array description: Array of items. Otherwise, null. items: $ref: "#/definitions/quote-data-cart-item-interface" items_count: type: integer description: Number of different items or products in the cart. Otherwise, null. items_qty: type: number description: Total quantity of all cart items. Otherwise, null. customer: $ref: "#/definitions/customer-data-customer-interface" billing_address: $ref: "#/definitions/quote-data-address-interface" reserved_order_id: type: string description: Reserved order ID. Otherwise, null. orig_order_id: type: integer description: Original order ID. Otherwise, null. currency: $ref: "#/definitions/quote-data-currency-interface" customer_is_guest: type: boolean description: For guest customers, false for logged in customers customer_note: type: string description: Notice text customer_note_notify: type: boolean description: Customer notification flag customer_tax_class_id: type: integer description: Customer tax class ID. store_id: type: integer description: Store identifier extension_attributes: $ref: "#/definitions/quote-data-cart-extension-interface" required: - id - customer - store_id quote-data-cart-item-interface: type: object description: Interface CartItemInterface properties: item_id: type: integer description: Item ID. Otherwise, null. sku: type: string description: Product SKU. Otherwise, null. qty: type: number description: Product quantity. name: type: string description: Product name. Otherwise, null. price: type: number description: Product price. Otherwise, null. product_type: type: string description: Product type. Otherwise, null. quote_id: type: string description: Quote id. product_option: $ref: "#/definitions/quote-data-product-option-interface" extension_attributes: $ref: "#/definitions/quote-data-cart-item-extension-interface" required: - qty - quote_id quote-data-product-option-interface: type: object description: Product option interface properties: extension_attributes: $ref: "#/definitions/quote-data-product-option-extension-interface" quote-data-product-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface properties: custom_options: type: array items: $ref: "#/definitions/catalog-data-custom-option-interface" bundle_options: type: array items: $ref: "#/definitions/bundle-data-bundle-option-interface" downloadable_option: $ref: "#/definitions/downloadable-data-downloadable-option-interface" giftcard_item_option: $ref: "#/definitions/gift-card-data-gift-card-option-interface" configurable_item_options: type: array items: $ref: "#/definitions/configurable-product-data-configurable-item-option-value-i\ nterface" grouped_options: type: array items: $ref: "#/definitions/grouped-product-data-grouped-options-interface" catalog-data-custom-option-interface: type: object description: Interface CustomOptionInterface properties: option_id: type: string description: Option id option_value: type: string description: Option value extension_attributes: $ref: "#/definitions/catalog-data-custom-option-extension-interface" required: - option_id - option_value catalog-data-custom-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface properties: file_info: $ref: "#/definitions/framework-data-image-content-interface" framework-data-image-content-interface: type: object description: Image Content data interface properties: base64_encoded_data: type: string description: Media data (base64 encoded content) type: type: string description: MIME type name: type: string description: Image name required: - base64_encoded_data - type - name bundle-data-bundle-option-interface: type: object description: Interface BundleOptionInterface properties: option_id: type: integer description: Bundle option id. option_qty: type: integer description: Bundle option quantity. option_selections: type: array description: Bundle option selection ids. items: type: integer extension_attributes: $ref: "#/definitions/bundle-data-bundle-option-extension-interface" required: - option_id - option_qty - option_selections bundle-data-bundle-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface downloadable-data-downloadable-option-interface: type: object description: Downloadable Option properties: downloadable_links: type: array description: The list of downloadable links items: type: integer required: - downloadable_links gift-card-data-gift-card-option-interface: type: object description: Interface GiftCardOptionInterface properties: giftcard_amount: type: string description: Gift card amount. custom_giftcard_amount: type: number description: Gift card open amount value. giftcard_sender_name: type: string description: Gift card sender name. giftcard_recipient_name: type: string description: Gift card recipient name. giftcard_sender_email: type: string description: Gift card sender email. giftcard_recipient_email: type: string description: Gift card recipient email. giftcard_message: type: string description: Giftcard message. extension_attributes: $ref: "#/definitions/gift-card-data-gift-card-option-extension-interface" required: - giftcard_amount - giftcard_sender_name - giftcard_recipient_name - giftcard_sender_email - giftcard_recipient_email gift-card-data-gift-card-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface properties: giftcard_created_codes: type: array items: type: string configurable-product-data-configurable-item-option-value-interface: type: object description: Interface ConfigurableItemOptionValueInterface properties: option_id: type: string description: Option SKU option_value: type: integer description: Item id extension_attributes: $ref: "#/definitions/configurable-product-data-configurable-item-option-value-e\ xtension-interface" required: - option_id configurable-product-data-configurable-item-option-value-extension-interface: type: object description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface grouped-product-data-grouped-options-interface: type: object description: Represents `product item id with qty` of a grouped product. properties: id: type: integer description: Associated product id qty: type: integer description: Associated product qty extension_attributes: $ref: "#/definitions/grouped-product-data-grouped-options-extension-interface" grouped-product-data-grouped-options-extension-interface: type: object description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface quote-data-cart-item-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface properties: discounts: type: array items: $ref: "#/definitions/sales-rule-data-rule-discount-interface" negotiable_quote_item: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" sales-rule-data-rule-discount-interface: type: object description: Rule discount Interface properties: discount_data: $ref: "#/definitions/sales-rule-data-discount-data-interface" rule_label: type: string description: Rule Label rule_id: type: integer description: Rule ID required: - discount_data - rule_label - rule_id sales-rule-data-discount-data-interface: type: object description: Discount Data Interface properties: amount: type: number description: Amount base_amount: type: number description: Base Amount original_amount: type: number description: Original Amount base_original_amount: type: number description: Base Original Amount required: - amount - base_amount - original_amount - base_original_amount negotiable-quote-data-negotiable-quote-item-interface: type: object description: Interface CompanyQuoteConfigInterface properties: item_id: type: integer description: Quote item id original_price: type: number description: Quote item original price original_tax_amount: type: number description: Quote item original tax amount original_discount_amount: type: number description: Quote item original discount amount extension_attributes: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-inte\ rface" required: - item_id - original_price - original_tax_amount - original_discount_amount negotiable-quote-data-negotiable-quote-item-extension-interface: type: object description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface quote-data-address-interface: type: object description: Interface AddressInterface properties: id: type: integer description: Id region: type: string description: Region name region_id: type: integer description: Region id region_code: type: string description: Region code country_id: type: string description: Country id street: type: array description: Street items: type: string company: type: string description: Company telephone: type: string description: Telephone number fax: type: string description: Fax number postcode: type: string description: Postcode city: type: string description: City name firstname: type: string description: First name lastname: type: string description: Last name middlename: type: string description: Middle name prefix: type: string description: Prefix suffix: type: string description: Suffix vat_id: type: string description: Vat id customer_id: type: integer description: Customer id email: type: string description: Billing/shipping email same_as_billing: type: integer description: Same as billing flag customer_address_id: type: integer description: Customer address id save_in_address_book: type: integer description: Save in address book flag extension_attributes: $ref: "#/definitions/quote-data-address-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" required: - region - region_id - region_code - country_id - street - telephone - postcode - city - firstname - lastname - email quote-data-address-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface properties: discounts: type: array items: $ref: "#/definitions/sales-rule-data-rule-discount-interface" gift_registry_id: type: integer pickup_location_code: type: string bolt_id: type: string quote-data-currency-interface: type: object description: Interface CurrencyInterface properties: global_currency_code: type: string description: Global currency code base_currency_code: type: string description: Base currency code store_currency_code: type: string description: Store currency code quote_currency_code: type: string description: Quote currency code store_to_base_rate: type: number description: Store currency to base currency rate store_to_quote_rate: type: number description: Store currency to quote currency rate base_to_global_rate: type: number description: Base currency to global currency rate base_to_quote_rate: type: number description: Base currency to quote currency rate extension_attributes: $ref: "#/definitions/quote-data-currency-extension-interface" quote-data-currency-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface quote-data-cart-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface properties: shipping_assignments: type: array items: $ref: "#/definitions/quote-data-shipping-assignment-interface" negotiable_quote: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-interface" quote-data-shipping-assignment-interface: type: object description: Interface ShippingAssignmentInterface properties: shipping: $ref: "#/definitions/quote-data-shipping-interface" items: type: array items: $ref: "#/definitions/quote-data-cart-item-interface" extension_attributes: $ref: "#/definitions/quote-data-shipping-assignment-extension-interface" required: - shipping - items quote-data-shipping-interface: type: object description: Interface ShippingInterface properties: address: $ref: "#/definitions/quote-data-address-interface" method: type: string description: Shipping method extension_attributes: $ref: "#/definitions/quote-data-shipping-extension-interface" required: - address - method quote-data-shipping-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface quote-data-shipping-assignment-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface negotiable-quote-data-negotiable-quote-interface: type: object description: Interface NegotiableQuoteInterface properties: quote_id: type: integer description: Negotiable quote ID. is_regular_quote: type: boolean description: Is regular quote. status: type: string description: Negotiable quote status. negotiated_price_type: type: integer description: Negotiated price type. negotiated_price_value: type: number description: Negotiated price value. shipping_price: type: number description: Proposed shipping price. quote_name: type: string description: Negotiable quote name. expiration_period: type: string description: Expiration period. email_notification_status: type: integer description: Email notification status. has_unconfirmed_changes: type: boolean description: Has unconfirmed changes. is_shipping_tax_changed: type: boolean description: Shipping tax changes. is_customer_price_changed: type: boolean description: Customer price changes. notifications: type: integer description: Quote notifications. applied_rule_ids: type: string description: Quote rules. is_address_draft: type: boolean description: Is address draft. deleted_sku: type: string description: Deleted products sku. creator_id: type: integer description: Quote creator id. creator_type: type: integer description: Quote creator type. original_total_price: type: number description: Quote original total price. base_original_total_price: type: number description: Quote original total price in base currency. negotiated_total_price: type: number description: Quote negotiated total price. base_negotiated_total_price: type: number description: Quote negotiated total price in base currency. extension_attributes: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" required: - quote_id - is_regular_quote - status - negotiated_price_type - negotiated_price_value - shipping_price - quote_name - expiration_period - email_notification_status - has_unconfirmed_changes - is_shipping_tax_changed - is_customer_price_changed - notifications - applied_rule_ids - is_address_draft - deleted_sku - creator_id - creator_type negotiable-quote-data-negotiable-quote-extension-interface: type: object description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface quote-data-payment-interface: type: object description: Interface PaymentInterface properties: po_number: type: string description: Purchase order number method: type: string description: Payment method code additional_data: type: array description: Payment additional details items: type: string extension_attributes: $ref: "#/definitions/quote-data-payment-extension-interface" required: - method quote-data-payment-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface properties: agreement_ids: type: array items: type: string quote-data-shipping-method-interface: type: object description: Interface ShippingMethodInterface properties: carrier_code: type: string description: Shipping carrier code. method_code: type: string description: Shipping method code. carrier_title: type: string description: Shipping carrier title. Otherwise, null. method_title: type: string description: Shipping method title. Otherwise, null. amount: type: number description: Shipping amount in store currency. base_amount: type: number description: Shipping amount in base currency. available: type: boolean description: The value of the availability flag for the current shipping method. extension_attributes: $ref: "#/definitions/quote-data-shipping-method-extension-interface" error_message: type: string description: Shipping Error message. price_excl_tax: type: number description: Shipping price excl tax. price_incl_tax: type: number description: Shipping price incl tax. required: - carrier_code - method_code - amount - base_amount - available - error_message - price_excl_tax - price_incl_tax quote-data-shipping-method-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface quote-data-payment-method-interface: type: object description: Interface PaymentMethodInterface properties: code: type: string description: Payment method code title: type: string description: Payment method title required: - code - title quote-data-totals-additional-data-interface: type: object description: Additional data for totals collection. properties: extension_attributes: $ref: "#/definitions/quote-data-totals-additional-data-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" quote-data-totals-additional-data-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface properties: gift_messages: type: array items: $ref: "#/definitions/gift-message-data-message-interface" gift-message-data-message-interface: type: object description: Interface MessageInterface properties: gift_message_id: type: integer description: Gift message ID. Otherwise, null. customer_id: type: integer description: Customer ID. Otherwise, null. sender: type: string description: Sender name. recipient: type: string description: Recipient name. message: type: string description: Message text. extension_attributes: $ref: "#/definitions/gift-message-data-message-extension-interface" required: - sender - recipient - message gift-message-data-message-extension-interface: type: object description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface properties: entity_id: type: string entity_type: type: string wrapping_id: type: integer wrapping_allow_gift_receipt: type: boolean wrapping_add_printed_card: type: boolean quote-data-totals-interface: type: object description: Interface TotalsInterface properties: grand_total: type: number description: Grand total in quote currency base_grand_total: type: number description: Grand total in base currency subtotal: type: number description: Subtotal in quote currency base_subtotal: type: number description: Subtotal in base currency discount_amount: type: number description: Discount amount in quote currency base_discount_amount: type: number description: Discount amount in base currency subtotal_with_discount: type: number description: Subtotal in quote currency with applied discount base_subtotal_with_discount: type: number description: Subtotal in base currency with applied discount shipping_amount: type: number description: Shipping amount in quote currency base_shipping_amount: type: number description: Shipping amount in base currency shipping_discount_amount: type: number description: Shipping discount amount in quote currency base_shipping_discount_amount: type: number description: Shipping discount amount in base currency tax_amount: type: number description: Tax amount in quote currency base_tax_amount: type: number description: Tax amount in base currency weee_tax_applied_amount: type: number description: Item weee tax applied amount in quote currency. shipping_tax_amount: type: number description: Shipping tax amount in quote currency base_shipping_tax_amount: type: number description: Shipping tax amount in base currency subtotal_incl_tax: type: number description: Subtotal including tax in quote currency base_subtotal_incl_tax: type: number description: Subtotal including tax in base currency shipping_incl_tax: type: number description: Shipping including tax in quote currency base_shipping_incl_tax: type: number description: Shipping including tax in base currency base_currency_code: type: string description: Base currency code quote_currency_code: type: string description: Quote currency code coupon_code: type: string description: Applied coupon code items_qty: type: integer description: Items qty items: type: array description: Totals by items items: $ref: "#/definitions/quote-data-totals-item-interface" total_segments: type: array description: Dynamically calculated totals items: $ref: "#/definitions/quote-data-total-segment-interface" extension_attributes: $ref: "#/definitions/quote-data-totals-extension-interface" required: - weee_tax_applied_amount - total_segments quote-data-totals-item-interface: type: object description: Interface TotalsItemInterface properties: item_id: type: integer description: Item id price: type: number description: Item price in quote currency. base_price: type: number description: Item price in base currency. qty: type: number description: Item quantity. row_total: type: number description: Row total in quote currency. base_row_total: type: number description: Row total in base currency. row_total_with_discount: type: number description: Row total with discount in quote currency. Otherwise, null. tax_amount: type: number description: Tax amount in quote currency. Otherwise, null. base_tax_amount: type: number description: Tax amount in base currency. Otherwise, null. tax_percent: type: number description: Tax percent. Otherwise, null. discount_amount: type: number description: Discount amount in quote currency. Otherwise, null. base_discount_amount: type: number description: Discount amount in base currency. Otherwise, null. discount_percent: type: number description: Discount percent. Otherwise, null. price_incl_tax: type: number description: Price including tax in quote currency. Otherwise, null. base_price_incl_tax: type: number description: Price including tax in base currency. Otherwise, null. row_total_incl_tax: type: number description: Row total including tax in quote currency. Otherwise, null. base_row_total_incl_tax: type: number description: Row total including tax in base currency. Otherwise, null. options: type: string description: Item price in quote currency. weee_tax_applied_amount: type: number description: Item weee tax applied amount in quote currency. weee_tax_applied: type: string description: Item weee tax applied in quote currency. extension_attributes: $ref: "#/definitions/quote-data-totals-item-extension-interface" name: type: string description: Product name. Otherwise, null. required: - item_id - price - base_price - qty - row_total - base_row_total - options - weee_tax_applied_amount - weee_tax_applied quote-data-totals-item-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface properties: negotiable_quote_item_totals: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interfa\ ce" negotiable-quote-data-negotiable-quote-item-totals-interface: type: object description: Extension attribute for quote item totals model. properties: cost: type: number description: Cost for quote item. catalog_price: type: number description: Catalog price for quote item. base_catalog_price: type: number description: Catalog price for quote item in base currency. catalog_price_incl_tax: type: number description: Catalog price with included tax for quote item. base_catalog_price_incl_tax: type: number description: Catalog price with included tax for quote item in base currency. cart_price: type: number description: Cart price for quote item. base_cart_price: type: number description: Cart price for quote item in base currency. cart_tax: type: number description: Tax from catalog price for quote item. base_cart_tax: type: number description: Tax from catalog price for quote item in base currency. cart_price_incl_tax: type: number description: Cart price with included tax for quote item. base_cart_price_incl_tax: type: number description: Cart price with included tax for quote item in base currency. extension_attributes: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extensi\ on-interface" required: - cost - catalog_price - base_catalog_price - catalog_price_incl_tax - base_catalog_price_incl_tax - cart_price - base_cart_price - cart_tax - base_cart_tax - cart_price_incl_tax - base_cart_price_incl_tax negotiable-quote-data-negotiable-quote-item-totals-extension-interface: type: object description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface quote-data-total-segment-interface: type: object description: Interface TotalsInterface properties: code: type: string description: Code title: type: string description: Total title value: type: number description: Total value area: type: string description: Display area code. extension_attributes: $ref: "#/definitions/quote-data-total-segment-extension-interface" required: - code - value quote-data-total-segment-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface properties: tax_grandtotal_details: type: array items: $ref: "#/definitions/tax-data-grand-total-details-interface" gift_cards: type: string gw_order_id: type: string gw_item_ids: type: array items: type: string gw_allow_gift_receipt: type: string gw_add_card: type: string gw_price: type: string gw_base_price: type: string gw_items_price: type: string gw_items_base_price: type: string gw_card_price: type: string gw_card_base_price: type: string gw_base_tax_amount: type: string gw_tax_amount: type: string gw_items_base_tax_amount: type: string gw_items_tax_amount: type: string gw_card_base_tax_amount: type: string gw_card_tax_amount: type: string gw_price_incl_tax: type: string gw_base_price_incl_tax: type: string gw_card_price_incl_tax: type: string gw_card_base_price_incl_tax: type: string gw_items_price_incl_tax: type: string gw_items_base_price_incl_tax: type: string tax-data-grand-total-details-interface: type: object description: Interface GrandTotalDetailsInterface properties: amount: type: number description: Tax amount value rates: type: array description: Tax rates info items: $ref: "#/definitions/tax-data-grand-total-rates-interface" group_id: type: integer description: Group identifier required: - amount - rates - group_id tax-data-grand-total-rates-interface: type: object description: Interface GrandTotalRatesInterface properties: percent: type: string description: Tax percentage value title: type: string description: Rate title required: - percent - title quote-data-totals-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface properties: coupon_label: type: string negotiable_quote_totals: $ref: "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" base_customer_balance_amount: type: number customer_balance_amount: type: number reward_points_balance: type: number reward_currency_amount: type: number base_reward_currency_amount: type: number negotiable-quote-data-negotiable-quote-totals-interface: type: object description: Extension attribute for quote totals model. properties: items_count: type: integer description: The number of different items or products in the cart. quote_status: type: string description: Negotiable quote status. created_at: type: string description: The cart creation date and time. updated_at: type: string description: The cart last update date and time. customer_group: type: integer description: Customer group id. base_to_quote_rate: type: number description: Base currency to quote currency rate. cost_total: type: number description: Total cost for quote. base_cost_total: type: number description: Total cost for quote in base currency. original_total: type: number description: Original quote total. base_original_total: type: number description: Original quote total in base currency. original_tax: type: number description: Original tax amount for quote. base_original_tax: type: number description: Original tax amount for quote in base currency. original_price_incl_tax: type: number description: Original price with included tax for quote. base_original_price_incl_tax: type: number description: Original price with included tax for quote in base currency. negotiated_price_type: type: integer description: Negotiable quote type. negotiated_price_value: type: number description: Negotiable price value for quote. required: - items_count - quote_status - created_at - updated_at - customer_group - base_to_quote_rate - cost_total - base_cost_total - original_total - base_original_total - original_tax - base_original_tax - original_price_incl_tax - base_original_price_incl_tax - negotiated_price_type - negotiated_price_value requisition-list-data-requisition-list-interface: type: object description: Interface RequisitionListInterface properties: id: type: integer description: Requisition List ID customer_id: type: integer description: Customer ID name: type: string description: Requisition List Name updated_at: type: string description: Requisition List Update Time description: type: string description: Requisition List Description items: type: array description: Requisition List Items items: $ref: "#/definitions/requisition-list-data-requisition-list-item-interface" extension_attributes: $ref: "#/definitions/requisition-list-data-requisition-list-extension-interface" required: - id - customer_id - name - updated_at - description - items requisition-list-data-requisition-list-item-interface: type: object description: Interface RequisitionListItemInterface properties: id: type: integer description: Requisition List ID. sku: type: string description: Product SKU. requisition_list_id: type: integer description: Requisition List ID. qty: type: number description: Product Qty. options: type: array description: Requisition list item options. items: type: string store_id: type: integer description: Store ID. added_at: type: string description: Added_at value. extension_attributes: $ref: "#/definitions/requisition-list-data-requisition-list-item-extension-inte\ rface" required: - id - sku - requisition_list_id - qty - options - store_id - added_at requisition-list-data-requisition-list-item-extension-interface: type: object description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface requisition-list-data-requisition-list-extension-interface: type: object description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface framework-search-search-result-interface: type: object description: Interface SearchResultInterface properties: items: type: array items: $ref: "#/definitions/framework-search-document-interface" aggregations: $ref: "#/definitions/framework-search-aggregation-interface" search_criteria: $ref: "#/definitions/framework-search-search-criteria-interface" total_count: type: integer description: Total count. required: - items - aggregations - search_criteria - total_count framework-search-document-interface: type: object description: Interface Search Document properties: id: type: integer custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" required: - id framework-search-aggregation-interface: type: object description: Interface Aggregation to get faceted data properties: buckets: type: array description: All Document fields items: $ref: "#/definitions/framework-search-bucket-interface" bucket_names: type: array description: Document field names items: type: string required: - buckets - bucket_names framework-search-bucket-interface: type: object description: Interface for facet Bucket properties: name: type: string description: Field name values: type: array description: Field values items: $ref: "#/definitions/framework-search-aggregation-value-interface" required: - name - values framework-search-aggregation-value-interface: type: object description: Interface Aggregation Value properties: value: type: string description: Aggregation metrics: type: array description: Metrics items: type: string required: - value - metrics framework-search-search-criteria-interface: type: object description: Interface SearchCriteriaInterface properties: request_name: type: string filter_groups: type: array description: A list of filter groups. items: $ref: "#/definitions/framework-search-filter-group" sort_orders: type: array description: Sort order. items: $ref: "#/definitions/framework-sort-order" page_size: type: integer description: Page size. current_page: type: integer description: Current page. required: - request_name - filter_groups framework-search-filter-group: type: object description: Groups two or more filters together using a logical OR properties: filters: type: array description: A list of filters in this group items: $ref: "#/definitions/framework-filter" framework-filter: type: object description: Filter which can be used by any methods from service layer. properties: field: type: string description: Field value: type: string description: Value condition_type: type: string description: Condition type required: - field - value framework-sort-order: type: object description: Data object for sort order. properties: field: type: string description: Sorting field. direction: type: string description: Sorting direction. required: - field - direction checkout-data-shipping-information-interface: type: object description: Interface ShippingInformationInterface properties: shipping_address: $ref: "#/definitions/quote-data-address-interface" billing_address: $ref: "#/definitions/quote-data-address-interface" shipping_method_code: type: string description: Shipping method code shipping_carrier_code: type: string description: Carrier code extension_attributes: $ref: "#/definitions/checkout-data-shipping-information-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" required: - shipping_address - shipping_method_code - shipping_carrier_code checkout-data-shipping-information-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface checkout-data-payment-details-interface: type: object description: Interface PaymentDetailsInterface properties: payment_methods: type: array items: $ref: "#/definitions/quote-data-payment-method-interface" totals: $ref: "#/definitions/quote-data-totals-interface" extension_attributes: $ref: "#/definitions/checkout-data-payment-details-extension-interface" required: - payment_methods - totals checkout-data-payment-details-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface checkout-data-totals-information-interface: type: object description: Interface TotalsInformationInterface properties: address: $ref: "#/definitions/quote-data-address-interface" shipping_method_code: type: string description: Shipping method code shipping_carrier_code: type: string description: Carrier code extension_attributes: $ref: "#/definitions/checkout-data-totals-information-extension-interface" custom_attributes: type: array description: Custom attributes values. items: $ref: "#/definitions/framework-attribute-interface" required: - address checkout-data-totals-information-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface two-factor-auth-provider-interface: type: object description: 2FA provider interface properties: enabled: type: boolean description: True if this provider has been enabled by admin engine: $ref: "#/definitions/two-factor-auth-engine-interface" code: type: string description: Provider code name: type: string description: Provider name icon: type: string description: Icon reset_allowed: type: boolean description: True if this provider configuration can be reset configure_action: type: string description: Configure action auth_action: type: string description: Auth action extra_actions: type: array description: Allowed extra actions items: type: string required: - enabled - engine - code - name - icon - reset_allowed - configure_action - auth_action - extra_actions two-factor-auth-engine-interface: type: object description: 2FA engine interface properties: enabled: type: boolean description: True if this provider has been enabled by admin required: - enabled two-factor-auth-data-google-configure-interface: type: object description: Google configuration data interface properties: qr_code_base64: type: string description: Value for QR code base 64 secret_code: type: string description: Value for secret code extension_attributes: $ref: "#/definitions/two-factor-auth-data-google-configure-extension-interface" required: - qr_code_base64 - secret_code two-factor-auth-data-google-configure-extension-interface: type: object description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface two-factor-auth-data-authy-device-interface: type: object description: Authy device data interface properties: country: type: string description: The country phone_number: type: string description: The phone number method: type: string description: The method to authenticate with extension_attributes: $ref: "#/definitions/two-factor-auth-data-authy-device-extension-interface" required: - country - phone_number - method two-factor-auth-data-authy-device-extension-interface: type: object description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface two-factor-auth-data-authy-registration-prompt-response-interface: type: object description: Response for device registration prompt properties: message: type: string description: The message expiration_seconds: type: string description: The seconds to expire extension_attributes: $ref: "#/definitions/two-factor-auth-data-authy-registration-prompt-response-ex\ tension-interface" required: - message - expiration_seconds two-factor-auth-data-authy-registration-prompt-response-extension-interface: type: object description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface two-factor-auth-data-u2f-web-authn-request-interface: type: object description: Represents a WebAuthn dataset properties: credential_request_options_json: type: string description: The needed data to initiate a WebAuthn registration ceremony extension_attributes: $ref: "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-inter\ face" required: - credential_request_options_json two-factor-auth-data-u2f-web-authn-request-extension-interface: type: object description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface two-factor-auth-data-duo-data-interface: type: object description: Represents the data needed to use duo properties: signature: type: string description: The signature api_hostname: type: string description: The api hostname extension_attributes: $ref: "#/definitions/two-factor-auth-data-duo-data-extension-interface" required: - signature - api_hostname two-factor-auth-data-duo-data-extension-interface: type: object description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\DuoDataInterface gift-card-account-data-gift-card-account-interface: type: object description: Gift Card Account data properties: gift_cards: type: array description: Cards codes. items: type: string gift_cards_amount: type: number description: Cards amount in quote currency. base_gift_cards_amount: type: number description: Cards amount in base currency. gift_cards_amount_used: type: number description: Cards amount used in quote currency. base_gift_cards_amount_used: type: number description: Cards amount used in base currency. extension_attributes: $ref: "#/definitions/gift-card-account-data-gift-card-account-extension-interfa\ ce" required: - gift_cards_amount - base_gift_cards_amount - gift_cards_amount_used - base_gift_cards_amount_used gift-card-account-data-gift-card-account-extension-interface: type: object description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface inventory-in-store-pickup-api-data-search-result-interface: type: object description: Search results for providing pickup locations. properties: items: type: array description: Items list. items: $ref: "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interfa\ ce" search_request: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-interfac\ e" total_count: type: integer description: Total count. required: - items - search_request - total_count inventory-in-store-pickup-api-data-pickup-location-interface: type: object description: Represents sources projection on In-Store Pickup context. Realisation must follow immutable DTO concept. Partial immutability done according to restriction of current Extension Attributes implementation. properties: pickup_location_code: type: string description: Source code of Pickup Location. name: type: string description: Pickup Location name. email: type: string description: Pickup Location contact email. fax: type: string description: Fax contact info. contact_name: type: string description: Pickup Location contact name. description: type: string description: Pickup Location description. latitude: type: number description: Pickup Location latitude. longitude: type: number description: Pickup Location longitude. country_id: type: string description: Pickup Location country ID. region_id: type: integer description: Pickup Location region ID. region: type: string description: Pickup Location region. city: type: string description: Pickup Location city. street: type: string description: Pickup Location street. postcode: type: string description: Pickup Location postcode. phone: type: string description: Pickup Location phone. extension_attributes: $ref: "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extensi\ on-interface" required: - pickup_location_code inventory-in-store-pickup-api-data-pickup-location-extension-interface: type: object description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface inventory-in-store-pickup-api-data-search-request-interface: type: object description: "Endpoint used to search Pickup Locations by different parameters: - by attribute filters fields @see \\Magento\\InventoryInStorePickupApi\\Api\\Data\\SearchRequest\\FiltersIn\ terface - by distance to the address @see \\Magento\\InventoryInStorePickupApi\\Api\\Data\\SearchRequest\\AreaInter\ face Also, endpoint supports paging and sort orders." properties: area: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-area-int\ erface" filters: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-\ interface" page_size: type: integer description: Page size. current_page: type: integer description: Current page. scope_type: type: string description: Sales Channel Type. scope_code: type: string description: Sales Channel code. sort: type: array description: Sort Order. items: $ref: "#/definitions/framework-sort-order" extension_attributes: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-extensio\ n-interface" required: - current_page - scope_type - scope_code inventory-in-store-pickup-api-data-search-request-area-interface: type: object description: "Filter by Distance to the Address. Pickup Locations will be filtered by distance according to the geo-position of the entered address. Required fields for the address are country and one of the field: region or city or postcode." properties: radius: type: integer description: Search radius in KM. search_term: type: string description: Search term string. required: - radius - search_term inventory-in-store-pickup-api-data-search-request-filters-interface: type: object description: Filter to filter by Fields. Each field may be filtered with different condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface properties: country: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" postcode: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" region: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" region_id: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" city: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" street: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" name: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" pickup_location_code: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-i\ nterface" inventory-in-store-pickup-api-data-search-request-filter-interface: type: object description: Filter for Pickup Location search. properties: value: type: string description: Value. condition_type: type: string description: Condition Type. required: - value - condition_type inventory-in-store-pickup-api-data-search-request-extension-interface: type: object description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface properties: products_info: type: array items: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-product-\ info-interface" inventory-in-store-pickup-api-data-search-request-product-info-interface: type: object description: Product Info Data Transfer Object. properties: sku: type: string description: Product SKU. extension_attributes: $ref: "#/definitions/inventory-in-store-pickup-api-data-search-request-product-\ info-extension-interface" required: - sku inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: type: object description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface quick-checkout-data-account-interface: type: object description: Data account interface properties: addresses: type: array description: Addresses items: $ref: "#/definitions/quick-checkout-data-address-interface" payment_methods: type: array description: Payment methods items: $ref: "#/definitions/quick-checkout-data-payment-method-interface" email: type: string description: Email first_name: type: string description: First name last_name: type: string description: Last name default_address_changed: type: boolean description: Shipping address changed required: - addresses - payment_methods - email - first_name - last_name - default_address_changed quick-checkout-data-address-interface: type: object description: Account address properties: id: type: string description: Id region: type: string description: Region region_code: type: string description: Region code region_id: type: string description: Region id country_id: type: string description: Country code in ISO_3166-2 format street: type: array description: Street items: type: string email: type: string description: Email telephone: type: string description: Telephone number postcode: type: string description: Postcode city: type: string description: City name firstname: type: string description: First name lastname: type: string description: Last name company: type: string description: Company external_address: type: boolean description: External address required: - id - country_id - street - email - telephone - postcode - city - firstname - lastname - company - external_address quick-checkout-data-payment-method-interface: type: object description: Account payment properties: id: type: string description: Id type: type: string description: Type last4: type: string description: Last four digits of card network: type: string description: Card network billing_address: $ref: "#/definitions/quick-checkout-data-address-interface" expiration_month: type: string description: Expiration month of the card expiration_year: type: string description: Expiration year of the card required: - id - type - last4 - network - expiration_month - expiration_year pay-pal-braintree-data-auth-data-interface: type: object description: Interface AuthDataInterface properties: client_token: type: string description: Client token display_name: type: string description: Display name action_success: type: string description: To success page logged_in: type: boolean store_code: type: string description: Current store code required: - display_name - action_success - logged_in - store_code x-tagGroups: - name: applepay tags: - applepay/auth - name: carts tags: - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} - carts/guest-carts/{cartId}/giftCards - carts/guest-carts/{cartId}/giftCards/{giftCardCode} - carts/mine - carts/mine/balance/apply - carts/mine/checkGiftCard/{giftCardCode} - carts/mine/collect-totals - carts/mine/payment-information - carts/mine/po-payment-information - carts/mine/set-payment-information - name: customers tags: - customers - customers/isEmailAvailable - customers/me/activate - customers/me/password - customers/password - customers/resetPassword - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} - name: directory tags: - directory/countries - directory/countries/{countryId} - directory/currency - name: giftregistry tags: - giftregistry/mine/estimate-shipping-methods - name: guest carts tags: - guest-carts - guest-carts/{cartId} - guest-carts/{cartId}/billing-address - guest-carts/{cartId}/collect-totals - guest-carts/{cartId}/coupons - guest-carts/{cartId}/coupons/{couponCode} - guest-carts/{cartId}/estimate-shipping-methods - guest-carts/{cartId}/gift-message - guest-carts/{cartId}/gift-message/{itemId} - guest-carts/{cartId}/items - guest-carts/{cartId}/items/{itemId} - guest-carts/{cartId}/order - guest-carts/{cartId}/payment-information - guest-carts/{cartId}/payment-methods - guest-carts/{cartId}/selected-payment-method - guest-carts/{cartId}/set-payment-information - guest-carts/{cartId}/shipping-information - guest-carts/{cartId}/shipping-methods - guest-carts/{cartId}/totals - guest-carts/{cartId}/totals-information - name: guest giftregistry tags: - guest-giftregistry/{cartId}/estimate-shipping-methods - name: integration tags: - integration/admin/token - integration/customer/revoke-customer-token - integration/customer/token - name: inventory tags: - inventory/in-store-pickup/pickup-locations/ - name: negotiable carts tags: - negotiable-carts/{cartId}/billing-address - negotiable-carts/{cartId}/coupons - negotiable-carts/{cartId}/coupons/{couponCode} - negotiable-carts/{cartId}/estimate-shipping-methods - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id - negotiable-carts/{cartId}/giftCards - negotiable-carts/{cartId}/giftCards/{giftCardCode} - negotiable-carts/{cartId}/payment-information - negotiable-carts/{cartId}/set-payment-information - negotiable-carts/{cartId}/shipping-information - negotiable-carts/{cartId}/totals - name: products render info tags: - products-render-info - name: purchase order carts tags: - purchase-order-carts/{cartId}/payment-information - purchase-order-carts/{cartId}/set-payment-information - name: quick checkout tags: - quick-checkout/account-details - quick-checkout/has-account - quick-checkout/storefront/has-account - name: requisition_lists tags: - requisition_lists - name: reward tags: - reward/mine/use-reward - name: search tags: - search - name: tfa tags: - tfa/provider/authy/activate - tfa/provider/authy/authenticate - tfa/provider/authy/authenticate-onetouch - tfa/provider/authy/configure - tfa/provider/authy/send-token/{via} - tfa/provider/duo_security/activate - tfa/provider/duo_security/authenticate - tfa/provider/duo_security/configure - tfa/provider/duo_security/get-authentication-data - tfa/provider/google/activate - tfa/provider/google/authenticate - tfa/provider/google/configure - tfa/provider/u2fkey/activate - tfa/provider/u2fkey/authentication-challenge - tfa/provider/u2fkey/configure - tfa/provider/u2fkey/verify - tfa/tfat-providers-to-activate - tfa/tfat-user-providers