Available Admin API calls
Learn about the available Admin API calls.
The following tables list the available Admin API calls.
Customer management
File management
/files/{fileId}/content
Action: GET
Mode: Sync
Order management
Refund management
Subscription management
/v1/subscriptions/
Action: GET
Mode: Sync
/v1/subscriptions/{subscriptionId}/
Action: GET
Mode: Sync
/v1/subscriptions/{subscriptionId}/activate
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/email
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/expiration-date
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/cancel
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/orders
Action: GET
Mode: Sync
/v1/subscriptions/{subscriptionId}/payment-option
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/payment-source
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/pending-actions
Action: GET
Mode: Async
/v1/subscriptions/{subscriptionId}/perpetual-price
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/preview
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/preview-cart
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/reduce
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/reference-id
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-price
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-product
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-quantity
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-type
Action: POST
Mode: Async
/v1/subscriptions/{subscriptionId}/ship-to-address
Action: POST
Mode: Async
Site management
Product management
Note that the products
in the URL path represent the current product administrator session and the calls that you make to manage products on your online store.
/v1/products
/v1/products/{baseProductId or baseERID}
/v1/products/{baseProductId or baseERID}/locales/{locale}
/v1/products/{baseProductId or ERID}/variation/{variationProductId
or variationERID}/locales/{locale}
OR
/v1/products/product/variation/{variationProductId or variationERID}/locales/{locale}
/v1/products/{baseProductId or baseERID}/deploy
/v1/products/{baseProductId or baseERID}/live-changes
/v1/products/{baseProductId or baseERID}/variations/{variationProductId or variationERID}/live-changes
OR
/v1/products/product/variations/{variationProductId or variationERID}/live-changes
/v1/products/{baseProductId or baseERID/variations/{variationProductId or variationERID}
OR
/v1/products/product/variations/{variationProductId or variationERID}
/v1/products/{baseProductId or bbasePaseERID}/retire
/v1/products/tasks
/v1/products/tasks/{taskId}
/v1/product/tasks?productId={productId)
Each paired request below performs the same task:
GET /v1/products/product/variations/{productId or ERID}
andGET /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}
POST /v1/products/product/variations/{productVariationId or variationERID}
andPOST /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}
DEL /v1/products/product/variations/{productVariatinId or variatinERID}
andDEL /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}
GET /v1/products/{productId or ERID}/locales/{locale} GET /v1/products/{productId or ERID}/variation/{productVariationId or variationERID}/locales/{locale}
Last updated