Shopware

Shopware Admin API

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API. For a better overview, all CRUD-endpoints are hidden by…

E-commerce#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.

For a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints
add the query parameter type=jsonapi.

Endpoints 52

Experimental

  • GETExperimental: Redirect to SSO login/oauth/sso/authExperimental: Creates a redirection to the SSO login page
  • GETExperimental: Is SSO environment/_info/is-ssoExperimental: Returns a boolean which indicates the it is a SSO environment or not
  • POSTExperimental: Invite a new SSO user/_action/sso/invite-userExperimental: Invite a new SSO user and sends a e-mail with the invite

Admin Api

  • POSTsetPayPalAsDefault/_action/paypal/saleschannel-defaultSets PayPal as the default payment method for a given SalesChannel, or all.
  • POSTposSyncProducts/_action/paypal/pos/sync/:salesChannelId/products
  • POSTposSyncImages/_action/paypal/pos/sync/:salesChannelId/images
  • POSTposSyncInventory/_action/paypal/pos/sync/:salesChannelId/inventory
  • POSTposSync/_action/paypal/pos/sync/:salesChannelId
  • POSTposSyncAbort/_action/paypal/pos/sync/abort/:runId
  • POSTposSyncReset/_action/paypal/pos/sync/reset/:salesChannelId
  • POSTposSyncCleanup/_action/paypal/pos/log/cleanup/:salesChannelId
  • GETposProductLog/paypal/pos/product-log/:salesChannelId
  • POSTposValidateApiCredentials/_action/paypal/pos/validate-api-credentials
  • POSTposFetchInformation/paypal/pos/fetch-information
  • POSTposCloneProductVisibility/_action/paypal/pos/clone-product-visibility
  • GETposGetProductCounts/paypal/pos/product-count?salesChannelId=&cloneSalesChannelId=
  • POSTregisterPosWebhook/_action/paypal/pos/webhook/registration/:salesChannelId
  • DELETEderegisterPosWebhook/_action/paypal/pos/webhook/registration/:salesChannelId
  • POSTexecutePosWebhook/_action/paypal/pos/webhook/execute/:salesChannelId
  • POSTtestApiCredentials/_action/paypal/test-api-credentials
  • POSTgetApiCredentials/_action/paypal/get-api-credentials
  • GETgetMerchantInformation/_action/paypal/merchant-information
  • POSTsaveSettings/_action/paypal/save-settings
  • GETgetWebhookStatus/_action/paypal/webhook/status/:salesChannelId
  • POSTregisterWebhook/_action/paypal/webhook/register/:salesChannelId
  • DELETEderegisterWebhook/_action/paypal/webhook/deregister/:salesChannelId
  • POSTexecuteWebhook/_action/paypal/webhook/execute

Admin API

  • GETDownload a shared config/_action/share-config/download/:entity/:idThis route is used to download a shared config
  • POSTUpload a shared config/_action/share-config/upload/:entityThis route is used to upload a shared config
  • GETdisputeList/paypal/disputeLoads a list of PayPal disputes
  • GETdisputeDetails/paypal/dispute/:disputeIdLoads the dispute details of the given PayPal dispute ID
  • GETorderDetails/paypal-v2/order/:orderTransactionId/:paypalOrderIdLoads the order details of the given PayPal order ID
  • GETauthorizationDetails/paypal-v2/authorization/:orderTransactionId/:authorizationIdLoads the authorization details of the given PayPal authorization ID
  • GETcaptureDetails/paypal-v2/capture/:orderTransactionId/:captureIdLoads the capture details of the given PayPal capture ID
  • GETrefundDetails/paypal-v2/refund/:orderTransactionId/:refundIdLoads the refund details of the given PayPal refund ID
  • POSTrefundCapture/_action/paypal-v2/refund-capture/:orderTransactionId/:captureId/:paypalOrderIdRefunds the PayPal capture and sets the state of the Shopware order transaction accordingly
  • POSTcaptureAuthorization/_action/paypal-v2/capture-authorization/:orderTransactionId/:authorizationIdCaptures the PayPal authorization and sets the state of the Shopware order transaction accordingly
  • POSTvoidAuthorization/_action/paypal-v2/void-authorization/:orderTransactionId/:authorizationIdVoids the PayPal authorization and sets the state of the Shopware order transaction accordingly
  • GETpaymentDetails/paypal/payment-details/:orderId/:paymentIdLoads the Payment details of the given PayPal ID
  • GETresourceDetails/paypal/resource-details/:resourceType/:resourceId/:orderIdLoads the PayPal resource details of the given resource ID

Advanced Search Entity Stream Filter

  • GETList with basic information of Advanced Search Entity Stream Filter resources./advanced-search-entity-stream-filter
  • POSTCreate a new Advanced Search Entity Stream Filter resources./advanced-search-entity-stream-filter
  • POSTSearch for the Advanced Search Entity Stream Filter resources./search/advanced-search-entity-stream-filter
  • GETDetailed information about a Advanced Search Entity Stream Filter resource./advanced-search-entity-stream-filter/:id
  • DELETEDelete a Advanced Search Entity Stream Filter resource./advanced-search-entity-stream-filter/:id
  • PATCHPartially update information about a Advanced Search Entity Stream Filter resource./advanced-search-entity-stream-filter/:id
  • POSTAggregate for the Advanced Search Entity Stream Filter resources./aggregate/advanced-search-entity-stream-filterAvailable since: 6.6.10.0

Advanced Search Synonym

  • GETList with basic information of Advanced Search Synonym resources./advanced-search-synonym
  • POSTCreate a new Advanced Search Synonym resources./advanced-search-synonym
  • POSTSearch for the Advanced Search Synonym resources./search/advanced-search-synonym
  • GETDetailed information about a Advanced Search Synonym resource./advanced-search-synonym/:id
  • DELETEDelete a Advanced Search Synonym resource./advanced-search-synonym/:id

API details

Base URL
https://demo-frontends.shopware.store/api
Authentication
OAuth 2.0 (password, client credentials flows) with 2 scopes
Operations
1997 operations on 1202 pathsPOST 879GET 578DELETE 272PATCH 267OPTIONS 1
3 marked deprecated
Main resources
Experimental 112PayPal 27Admin Api 24Appointment 22Admin API 13System Config 12System Operations 12Theme 12System Info & Health Check 10Asset Management 9
Response formats
application/json application/vnd.api+json application\/json application/octet-stream
Description format
OpenAPI 3.1.0, API version 6.7.10.1

How to test the Shopware Admin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Shopware Admin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (password, client credentials flows) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Experimental: Redirect to SSO login” (GET /oauth/sso/auth), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Shopware Admin API?

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API. For a better overview, all CRUD-endpoints are hidden by… It is listed under E-commerce and has 1997 endpoints.

Who publishes the Shopware Admin API?

It is listed from Shopware's public API description (an OpenAPI document), not published by Shopware on Swastik Codes. Anyone who controls shopware.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Shopware Admin API?

Requests go to https://demo-frontends.shopware.store/api. Endpoint paths are added to this base URL.

How do I authenticate with the Shopware Admin API?

With OAuth 2.0 (password, client credentials flows) with 2 scopes.

How many endpoints does the Shopware Admin API have?

1997 operations on 1202 paths (879 POST, 578 GET, 272 DELETE, 267 PATCH, 1 OPTIONS). The largest groups are Experimental, PayPal, Admin Api, Appointment. This listing's collection holds the first 400.

Is forking the Shopware Admin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.