How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MODIVO Commerce REST API

The public REST surface of the MODIVO storefront, served by its Adobe Commerce / Magento 2.4 deployment at https://modivo.pl/rest/all and self-described by a Swagger 2.0 document the platform generates at /rest/all/schema?services=all. 57 operations across 48 paths cover guest cart creation and management, shipping and totals estimation, coupon application, payment method selection and guest order placement, customer account creation and password reset, product render info, catalog search, directory (country/currency) reference data, gift messages, in-store pickup locations, PayPal and Braintree payment services, and MODIVO-specific extensions for marketplace order placement, the MODIVO My Returns webhook, a JWT issuing service and a Trustmate review display integration. Anonymous callers can read directory and guest-cart resources; everything else requires a Magento integration or customer bearer token.

This API exposes 57 operations across 48 paths, organized into 32 resource areas, and defines 135 schemas. It is described by OpenAPI 3.0.3, at version 2.4.

Requests are made against a single base URL, https://modivo.pl/rest/all.

57 operations 48 paths 135 schemas 2 DELETE28 GET21 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.4
Base URL
https://modivo.pl/rest/all
Authentication
API Key
Resource Areas
32

Authentication & Security 1

MODIVO Commerce REST API declares 1 security scheme for authenticating requests. An API key is passed in the header as api_key (api_key).

  • api_key — Magento integration/customer bearer token supplied in the Authorization header (Bearer ).

Paths & Operations 57

Across 48 paths, the API surfaces 57 operations — 2 DELETE, 28 GET, 21 POST, 6 PUT. They span 32 resource areas, including directoryCurrencyInformationAcquirerV1, directoryCountryInformationAcquirerV1, customerAccountManagementV1, searchV1, catalogProductRenderListV1, quoteGuestCartRepositoryV1, quoteGuestCartManagementV1, quoteGuestShippingMethodManagementV1, and 24 more. Each is listed below with its method, path, parameters, and response codes.

directoryCurrencyInformationAcquirerV1 1

Currency information acquirer interface

GET
/V1/directory/currency
Get currency information for the store.
GetV1DirectoryCurrency → 200default
directoryCountryInformationAcquirerV1 2

Country information acquirer interface

GET
/V1/directory/countries
Get all countries and regions information for the store.
GetV1DirectoryCountries → 200default
GET
/V1/directory/countries/{countryId}
Get country and region information for the store.
GetV1DirectoryCountriesCountryId 1 param → 200400default
customerAccountManagementV1 5

Interface for managing customers accounts.

POST
/V1/customers
Create customer account. Perform necessary business operations like sending email.
PostV1Customers body → 200500default
GET
/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}
Check if password reset token is valid.
GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken 2 params → 200400500default
PUT
/V1/customers/password
Send an email to the customer with a password reset link.
PutV1CustomersPassword body → 200500default
POST
/V1/customers/resetPassword
Reset customer password.
PostV1CustomersResetPassword body → 200500default
POST
/V1/customers/isEmailAvailable
Check if given email is associated with a customer account in given website.
PostV1CustomersIsEmailAvailable body → 200500default
searchV1 1

Search API for all requests

GET
/V1/search
Make Full Text Search and return found Documents
GetV1Search 8 params → 200default
catalogProductRenderListV1 1

Interface which provides product renders information for products.

GET
/V1/products-render-info
Collect and retrieve the list of product render info. This info contains raw prices and formatted prices, product name, stock status, storeid, etc.
GetV1Productsrenderinfo 9 params → 200default
quoteGuestCartRepositoryV1 1

Cart Repository interface for guest carts.

GET
/V1/guest-carts/{cartId}
Enable a guest user to return information for a specified cart.
GetV1GuestcartsCartId 1 param → 200400default
quoteGuestCartManagementV1 2

Cart Management interface for guest carts.

POST
/V1/guest-carts
Enable an customer or guest user to create an empty cart and quote for an anonymous customer.
PostV1Guestcarts → 200400default
PUT
/V1/guest-carts/{cartId}/order
Place an order for a specified cart.
PutV1GuestcartsCartIdOrder 1 param body → 200400default
quoteGuestShippingMethodManagementV1 1

Shipping method management interface for guest carts.

GET
/V1/guest-carts/{cartId}/shipping-methods
List applicable shipping methods for a specified quote.
GetV1GuestcartsCartIdShippingmethods 1 param → 200400default
quoteGuestShipmentEstimationV1 1

Interface GuestShipmentEstimationInterface

POST
/V1/guest-carts/{cartId}/estimate-shipping-methods
Estimate shipping by address and return list of available shipping methods
PostV1GuestcartsCartIdEstimateshippingmethods 1 param body → 200400default
quoteGuestCartItemRepositoryV1 4

Cart Item repository interface for guest carts.

GET
/V1/guest-carts/{cartId}/items
List items that are assigned to a specified cart.
GetV1GuestcartsCartIdItems 1 param → 200400default
POST
/V1/guest-carts/{cartId}/items
Add/update the specified cart item.
PostV1GuestcartsCartIdItems 1 param body → 200400default
PUT
/V1/guest-carts/{cartId}/items/{itemId}
Add/update the specified cart item.
PutV1GuestcartsCartIdItemsItemId 2 params body → 200400default
DELETE
/V1/guest-carts/{cartId}/items/{itemId}
Remove the specified item from the specified cart.
DeleteV1GuestcartsCartIdItemsItemId 2 params → 200400default
quoteGuestPaymentMethodManagementV1 3

Payment method management interface for guest carts.

GET
/V1/guest-carts/{cartId}/selected-payment-method
Return the payment method for a specified shopping cart.
GetV1GuestcartsCartIdSelectedpaymentmethod 1 param → 200400default
PUT
/V1/guest-carts/{cartId}/selected-payment-method
Add a specified payment method to a specified shopping cart.
PutV1GuestcartsCartIdSelectedpaymentmethod 1 param body → 200400default
GET
/V1/guest-carts/{cartId}/payment-methods
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://develop…
GetV1GuestcartsCartIdPaymentmethods 1 param → 200400default
quoteGuestBillingAddressManagementV1 2

Billing address management interface for guest carts.

GET
/V1/guest-carts/{cartId}/billing-address
Return the billing address for a specified quote.
GetV1GuestcartsCartIdBillingaddress 1 param → 200400default
POST
/V1/guest-carts/{cartId}/billing-address
Assign a specified billing address to a specified cart.
PostV1GuestcartsCartIdBillingaddress 1 param body → 200400default
quoteGuestCouponManagementV1 3

Coupon management interface for guest carts.

GET
/V1/guest-carts/{cartId}/coupons
Return information for a coupon in a specified cart.
GetV1GuestcartsCartIdCoupons 1 param → 200400default
DELETE
/V1/guest-carts/{cartId}/coupons
Delete a coupon from a specified cart.
DeleteV1GuestcartsCartIdCoupons 1 param → 200400default
PUT
/V1/guest-carts/{cartId}/coupons/{couponCode}
Add a coupon by code to a specified cart.
PutV1GuestcartsCartIdCouponsCouponCode 2 params → 200400default
quoteGuestCartTotalManagementV1 1

Bundled API to collect totals for cart based on shipping/payment methods and additional data.

PUT
/V1/guest-carts/{cartId}/collect-totals
Set shipping/billing methods and additional data for cart and collect totals for guest.
PutV1GuestcartsCartIdCollecttotals 1 param body → 200default
quoteGuestCartTotalRepositoryV1 1

Cart totals repository interface for guest carts.

GET
/V1/guest-carts/{cartId}/totals
Return quote totals data for a specified cart.
GetV1GuestcartsCartIdTotals 1 param → 200400default
checkoutGuestShippingInformationManagementV1 1

Interface for managing guest shipping address information

POST
/V1/guest-carts/{cartId}/shipping-information
PostV1GuestcartsCartIdShippinginformation 1 param body → 200default
checkoutGuestTotalsInformationManagementV1 1

Interface for guest quote totals calculation

POST
/V1/guest-carts/{cartId}/totals-information
Calculate quote totals based on address and shipping method.
PostV1GuestcartsCartIdTotalsinformation 1 param body → 200default
checkoutGuestPaymentInformationManagementV1 3

Interface for managing guest payment information

POST
/V1/guest-carts/{cartId}/payment-information
Set payment information and place order for a specified cart.
PostV1GuestcartsCartIdPaymentinformation 1 param body → 200400default
GET
/V1/guest-carts/{cartId}/payment-information
Get payment information
GetV1GuestcartsCartIdPaymentinformation 1 param → 200default
POST
/V1/guest-carts/{cartId}/set-payment-information
Set payment information for a specified cart.
PostV1GuestcartsCartIdSetpaymentinformation 1 param body → 200400default
integrationAdminTokenServiceV1 1

Interface providing token generation for Admins

POST
/V1/integration/admin/token
Create access token for admin given the admin credentials.
PostV1IntegrationAdminToken body → 200400500default
integrationCustomerTokenServiceV1 1

Interface providing token generation for Customers

POST
/V1/integration/customer/token
Create access token for admin given the customer credentials.
PostV1IntegrationCustomerToken body → 200400401default
giftMessageGuestCartRepositoryV1 2

Interface GuestCartRepositoryInterface

GET
/V1/guest-carts/{cartId}/gift-message
Return the gift message for a specified order.
GetV1GuestcartsCartIdGiftmessage 1 param → 200default
POST
/V1/guest-carts/{cartId}/gift-message
Set the gift message for an entire order.
PostV1GuestcartsCartIdGiftmessage 1 param body → 200400default
giftMessageGuestItemRepositoryV1 2

Interface GuestItemRepositoryInterface

GET
/V1/guest-carts/{cartId}/gift-message/{itemId}
Return the gift message for a specified item in a specified shopping cart.
GetV1GuestcartsCartIdGiftmessageItemId 2 params → 200400default
POST
/V1/guest-carts/{cartId}/gift-message/{itemId}
Set the gift message for a specified item in a specified shopping cart.
PostV1GuestcartsCartIdGiftmessageItemId 2 params body → 200400default
inventoryInStorePickupApiGetPickupLocationsV1 1

Get Pickup Locations filtered by provided Search Request. Pickup Location entities are Immutable object and can not be changed after creation. All modification of Pickup Location…

GET
/V1/inventory/in-store-pickup/pickup-locations/
Get Pickup Locations according to the results of filtration by Search Request.
GetV1InventoryInstorepickupPickuplocations 25 params → 200default
paymentServicesPaypalPaymentConfigRequestV1 5
GET
/V1/payments-config/{location}
Get Config.
GetV1PaymentsconfigLocation 1 param → 200500default
GET
/V1/payments-config/google-pay/{location}
Get Google Pay Config.
GetV1PaymentsconfigGooglepayLocation 1 param → 200500default
GET
/V1/payments-config/apple-pay/{location}
Get Apple Pay Config.
GetV1PaymentsconfigApplepayLocation 1 param → 200500default
GET
/V1/payments-config/smart-buttons/{location}
Get Smart Buttons Config.
GetV1PaymentsconfigSmartbuttonsLocation 1 param → 200500default
GET
/V1/payments-config/hosted-fields/{location}
Get Hosted Fields Config.
GetV1PaymentsconfigHostedfieldsLocation 1 param → 200500default
paymentServicesPaypalPaymentOrderRequestV1 3

An interface for the REST WebAPI request to create an order

POST
/V1/guest-carts/{cartId}/payment-order
Create a payment order for guest customer
PostV1GuestcartsCartIdPaymentorder 1 param body → 200500default
GET
/V1/guest-carts/{cartId}/payment-order/{id}
Get payment order for guest customer
GetV1GuestcartsCartIdPaymentorderId 2 params → 200500default
POST
/V1/guest-carts/{cartId}/payment-order/{id}
Sync payment order for guest customer
PostV1GuestcartsCartIdPaymentorderId 2 params → 200500default
paymentServicesPaypalPaymentSdkRequestV1 2

An interface for the REST WebAPI to get payment sdk urls

GET
/V1/payments-sdk/{location}
Get payment sdk url by location
GetV1PaymentssdkLocation 1 param → 200default
GET
/V1/payments-sdk/{location}/{methodCode}
Get payment sdk url by location and methodCode
GetV1PaymentssdkLocationMethodCode 2 params → 200default
paymentServicesPaypalCompleteOrderV1 1
POST
/V1/payment-order/completeOrder
Rest API endpoint to place an order
PostV1PaymentorderCompleteOrder body → 200default
eobJWTHttpServiceV1 1

Interface HttpServiceInterface

POST
/V1/jwt/obtain
Create and retrieve JWT.
PostV1JwtObtain → 200500default
eobTrustmateIntegrationDisplayApiV1 1
GET
/V1/trustmate/displayapi/
GetV1TrustmateDisplayapi → 200default
marketplacePlaceOrderOrderManagementV1 1
POST
/V1/orderManagement/placeOrder
PostV1OrderManagementPlaceOrder body → 200default
modivoMyReturnsWebhookWebhookV1 1
POST
/V1/my-return-webhook/add-return-number-to-order
Add return number to order api
PostV1MyreturnwebhookAddreturnnumbertoorder body → 200500default
payPalBraintreeAuthV1 1

Interface AuthInterface

GET
/V1/applepay/auth
Returns details required to be able to submit a payment with Apple Pay
GetV1ApplepayAuth → 200default

Schemas 135

The contract defines 135 schemas that model the data the API accepts and returns. The most detailed are quote-data-totals-interface (28 properties), quote-data-address-interface (24 properties), customer-data-customer-interface (23 properties), quote-data-totals-item-interface (22 properties). Each schema is shown below with its type and property counts.

error-response
object
5 properties 1 required
error-errors
array
Errors list
error-errors-item
object
Error details
2 properties
error-parameters
array
Error parameters list
error-parameters-item
object
Error parameters item
3 properties
directory-data-currency-information-interface
object
Currency Information interface.
7 properties 6 required
directory-data-exchange-rate-interface
object
Exchange Rate interface.
3 properties 2 required
directory-data-exchange-rate-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface
directory-data-currency-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface
directory-data-country-information-interface
object
Country Information interface.
7 properties 5 required
directory-data-region-information-interface
object
Region Information interface.
4 properties 3 required
directory-data-region-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface
directory-data-country-information-extension-interface
object
ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
customer-data-customer-interface
object
Customer entity interface for API handling.
23 properties 3 required
customer-data-address-interface
object
Customer address interface.
21 properties
customer-data-region-interface
object
Customer address region interface.
4 properties 3 required
customer-data-region-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface
customer-data-address-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface
framework-attribute-interface
object
Interface for custom attribute value.
2 properties 2 required
customer-data-customer-extension-interface
object
ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
2 properties
framework-search-search-result-interface
object
Interface SearchResultInterface
4 properties 4 required
framework-search-document-interface
object
Interface Search Document
2 properties 1 required
framework-search-aggregation-interface
object
Interface Aggregation to get faceted data
2 properties 2 required
framework-search-bucket-interface
object
Interface for facet Bucket
2 properties 2 required
framework-search-aggregation-value-interface
object
Interface Aggregation Value
2 properties 2 required
framework-search-search-criteria-interface
object
Interface SearchCriteriaInterface
5 properties 2 required
framework-search-filter-group
object
Groups two or more filters together using a logical OR
1 property
framework-filter
object
Filter which can be used by any methods from service layer.
3 properties 2 required
framework-sort-order
object
Data object for sort order.
2 properties 2 required
catalog-data-product-render-search-results-interface
object
Dto that holds render information about products
1 property 1 required
catalog-data-product-render-interface
object
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
12 properties 12 required
catalog-data-product-render-button-interface
object
Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should h…
4 properties 3 required
catalog-data-product-render-button-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface
catalog-data-product-render-price-info-interface
object
Price interface.
9 properties 8 required
catalog-data-product-render-formatted-price-info-interface
object
Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html
8 properties 7 required
catalog-data-product-render-formatted-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface
catalog-data-product-render-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface
4 properties
msrp-data-product-render-msrp-price-info-interface
object
Price interface.
6 properties 5 required
msrp-data-product-render-msrp-price-info-extension-interface
object
ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface
weee-data-product-render-weee-adjustment-attribute-interface
object
List of all weee attributes, their amounts, etc.., that product has
6 properties 6 required
weee-data-product-render-weee-adjustment-attribute-extension-interface
object
ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface
catalog-data-product-render-image-interface
object
Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view
8 properties 7 required
catalog-data-product-render-image-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface
catalog-data-product-render-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface
2 properties
quote-data-cart-interface
object
Interface CartInterface
20 properties 3 required
quote-data-cart-item-interface
object
Interface CartItemInterface
9 properties 2 required
quote-data-product-option-interface
object
Product option interface
1 property
quote-data-product-option-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface
5 properties
catalog-data-custom-option-interface
object
Interface CustomOptionInterface
3 properties 2 required
catalog-data-custom-option-extension-interface
object
ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface
1 property
framework-data-image-content-interface
object
Image Content data interface
3 properties 3 required
configurable-product-data-configurable-item-option-value-interface
object
Interface ConfigurableItemOptionValueInterface
3 properties 1 required
configurable-product-data-configurable-item-option-value-extension-interface
object
ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface
bundle-data-bundle-option-interface
object
Interface BundleOptionInterface
4 properties 3 required
bundle-data-bundle-option-extension-interface
object
ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface
downloadable-data-downloadable-option-interface
object
Downloadable Option
1 property 1 required
grouped-product-data-grouped-options-interface
object
Represents product item id with qty of a grouped product.
3 properties
grouped-product-data-grouped-options-extension-interface
object
ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface
quote-data-cart-item-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface
1 property
sales-rule-data-rule-discount-interface
object
Rule discount Interface
3 properties 3 required
sales-rule-data-discount-data-interface
object
Discount Data Interface
4 properties 4 required
quote-data-address-interface
object
Interface AddressInterface
24 properties 11 required
quote-data-address-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface
9 properties
quote-data-currency-interface
object
Interface CurrencyInterface
9 properties
quote-data-currency-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface
quote-data-cart-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface
13 properties
quote-data-shipping-assignment-interface
object
Interface ShippingAssignmentInterface
3 properties 2 required
quote-data-shipping-interface
object
Interface ShippingInterface
3 properties 2 required
quote-data-shipping-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface
quote-data-shipping-assignment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface
eob-duty-calculator-data-duty-interface
object
4 properties 4 required
instore-sales-data-quote-extended-data-interface
object
Interface QuoteExtendedDataInterface
3 properties 3 required
quote-data-payment-interface
object
Interface PaymentInterface
4 properties 1 required
quote-data-payment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface
1 property
quote-data-shipping-method-interface
object
Interface ShippingMethodInterface
11 properties 8 required
quote-data-shipping-method-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface
quote-data-payment-method-interface
object
Interface PaymentMethodInterface
2 properties 2 required
quote-data-totals-additional-data-interface
object
Additional data for totals collection.
2 properties
quote-data-totals-additional-data-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface
1 property
gift-message-data-message-interface
object
Interface MessageInterface
6 properties 3 required
gift-message-data-message-extension-interface
object
ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface
2 properties
quote-data-totals-interface
object
Interface TotalsInterface
28 properties 2 required
quote-data-totals-item-interface
object
Interface TotalsItemInterface
22 properties 9 required
quote-data-totals-item-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface
quote-data-total-segment-interface
object
Interface TotalsInterface
5 properties 2 required
quote-data-total-segment-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface
1 property
tax-data-grand-total-details-interface
object
Interface GrandTotalDetailsInterface
3 properties 3 required
tax-data-grand-total-rates-interface
object
Interface GrandTotalRatesInterface
2 properties 2 required
quote-data-totals-extension-interface
object
ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface
1 property
checkout-data-shipping-information-interface
object
Interface ShippingInformationInterface
6 properties 3 required
checkout-data-shipping-information-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface
checkout-data-payment-details-interface
object
Interface PaymentDetailsInterface
3 properties 2 required
checkout-data-payment-details-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface
checkout-data-totals-information-interface
object
Interface TotalsInformationInterface
5 properties 1 required
checkout-data-totals-information-extension-interface
object
ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface
inventory-in-store-pickup-api-data-search-result-interface
object
Search results for providing pickup locations.
3 properties 3 required
inventory-in-store-pickup-api-data-pickup-location-interface
object
Represents sources projection on In-Store Pickup context. Realisation must follow immutable DTO concept. Partial immutability done according to restriction of…
16 properties 1 required
inventory-in-store-pickup-api-data-pickup-location-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface
inventory-in-store-pickup-api-data-search-request-interface
object
Endpoint used to search Pickup Locations by different parameters: - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\…
8 properties 3 required
inventory-in-store-pickup-api-data-search-request-area-interface
object
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…
2 properties 2 required
inventory-in-store-pickup-api-data-search-request-filters-interface
object
Filter to filter by Fields. Each field may be filtered with different condition type. Supported condition types restricted by @see \Magento\Framework\Api\Searc…
8 properties
inventory-in-store-pickup-api-data-search-request-filter-interface
object
Filter for Pickup Location search.
2 properties 2 required
inventory-in-store-pickup-api-data-search-request-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface
1 property
inventory-in-store-pickup-api-data-search-request-product-info-interface
object
Product Info Data Transfer Object.
2 properties 1 required
inventory-in-store-pickup-api-data-search-request-product-info-extension-interface
object
ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface
payment-services-paypal-payment-config-response-interface
object
4 properties 4 required
payment-services-paypal-data-payment-config-apple-pay-interface
object
8 properties 8 required
payment-services-paypal-data-payment-config-button-styles-interface
object
7 properties 7 required
payment-services-paypal-data-payment-config-sdk-params-interface
object
2 properties 2 required
payment-services-paypal-data-payment-config-google-pay-interface
object
9 properties 9 required
payment-services-paypal-data-payment-config-google-pay-button-styles-interface
object
3 properties 3 required
payment-services-paypal-data-payment-config-hosted-fields-interface
object
11 properties 11 required
payment-services-paypal-data-payment-config-smart-buttons-interface
object
10 properties 10 required
payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface
object
2 properties 2 required
payment-services-paypal-data-payment-config-smart-buttons-logo-interface
object
1 property 1 required
payment-services-paypal-data-payment-order-interface
object
Interface PaymentOrderInterface
5 properties 5 required
payment-services-paypal-data-payment-order-details-interface
object
Interface PaymentOrderDetailsInterface
6 properties 6 required
payment-services-paypal-data-payment-source-details-interface
object
1 property 1 required
payment-services-paypal-data-payment-card-details-interface
object
5 properties 5 required
payment-services-paypal-data-payment-card-bin-details-interface
object
1 property 1 required
payment-services-paypal-data-payment-sdk-params-interface
object
2 properties 2 required
eob-jw-tdata-token-data-interface
object
2 properties 2 required
marketplace-place-order-data-order-interface
object
14 properties 9 required
marketplace-place-order-data-order-suborder-interface
object
7 properties 6 required
marketplace-place-order-data-order-suborder-item-interface
object
6 properties 6 required
marketplace-order-create-data-order-suborder-delivery-method-interface
object
3 properties 2 required
marketplace-order-create-data-order-suborder-note-interface
object
2 properties 1 required
marketplace-order-create-data-order-payment-interface
object
5 properties 3 required
marketplace-order-create-data-order-payment-bank-transfer-details-interface
object
2 properties 2 required
marketplace-order-create-data-order-customer-interface
object
3 properties 3 required
marketplace-order-create-data-order-shipping-address-interface
object
12 properties 10 required
marketplace-order-create-data-order-billing-address-interface
object
14 properties 13 required
stanley-order-create-data-attribute-interface
object
2 properties 2 required
marketplace-place-order-data-order-response-interface
object
3 properties 3 required
pay-pal-braintree-data-auth-data-interface
object
Interface AuthDataInterface
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

modivo-commerce-rest-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of MODIVO Commerce REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.