Available Admin API calls

Learn about the available Admin API calls.

The following tables list the available Admin API calls.

Customer management

Path	Details
/v1/customers/{customerId}
/v1/customers/{customerId}/requestPIIRemoval

File management

Path	Details
/files/{fileId}/content	Mode: Sync

Order management

Path	Details
/v1/orders/{orderId}	Mode: Sync
/v1/orders/{orderId}/invoices	Mode: Sync
/v1/orders/{orderId}/invoices/{receiptId}	Mode: Sync

Refund management

Path	Details
/orders/{orderId}/refunds	Mode: Sync
/orders/{orderid}/refunds/schema	Mode: Sync
/orders/{orderId}/refunds-available	Mode: Sync

Subscription management

Path	Details
/v1/subscriptions/	Mode: Sync
/v1/subscriptions/{subscriptionId}/	Mode: Sync
/v1/subscriptions/{subscriptionId}/activate	Mode: Async
/v1/subscriptions/{subscriptionId}/email	Mode: Async
/v1/subscriptions/{subscriptionId}/expiration-date	Mode: Async
/v1/subscriptions/{subscriptionId}/cancel	Mode: Async
/v1/subscriptions/{subscriptionId}/orders	Mode: Sync
/v1/subscriptions/{subscriptionId}/payment-option	Mode: Async
/v1/subscriptions/{subscriptionId}/payment-source	Mode: Async
/v1/subscriptions/{subscriptionId}/pending-actions	Mode: Async
/v1/subscriptions/{subscriptionId}/perpetual-price	Mode: Async
/v1/subscriptions/{subscriptionId}/preview	Mode: Async
/v1/subscriptions/{subscriptionId}/preview-cart	Mode: Async
/v1/subscriptions/{subscriptionId}/reduce	Mode: Async
/v1/subscriptions/{subscriptionId}/reference-id	Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-price	Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-product	Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-quantity	Mode: Async
/v1/subscriptions/{subscriptionId}/renewal-type	Mode: Async
/v1/subscriptions/{subscriptionId}/ship-to-address	Mode: Async

Site management

Path	Details
/v1/sites/{siteId}/authorized-billing-countries	Mode: Sync Deployment validation: No
/v1/sites/{siteId}/authorized-shipping-countries	Mode: Sync Deployment validation: No

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.

Path	Details
/v1/products	ERID support: Yes Mode: Async Deployment validation: Yes
/v1/products/{baseProductId or baseERID}	ERID support: Yes Mode: Sync Deployment validation: No ERID support: Yes Mode: Async Deployment validation: Yes
/v1/products/{baseProductId or baseERID}/locales/{locale}	ERID support: Yes Mode: Sync Deployment validation: No ERID support: Yes Mode: Async Deployment validation: Yes ERID support: Yes Mode: Async Deployment validation: No
/v1/products/{baseProductId or ERID}/variation/{variationProductId or variationERID}/locales/{locale} OR /v1/products/product/variation/{variationProductId or variationERID}/locales/{locale}	ERID support: Yes Mode: Sync Deployment validation: No
/v1/products/{baseProductId or baseERID}/deploy	ERID support: Yes Mode: Async Deployment validation: Yes
/v1/products/{baseProductId or baseERID}/live-changes	ERID support: Yes Mode: Async Deployment validation: Yes
/v1/products/{baseProductId or baseERID}/variations/{variationProductId or variationERID}/live-changes OR /v1/products/product/variations/{variationProductId or variationERID}/live-changes	ERID support: Yes Mode: Async Deployment validation: Yes
/v1/products/{baseProductId or baseERID/variations/{variationProductId or variationERID} OR /v1/products/product/variations/{variationProductId or variationERID}	ERID support: Yes Mode: Sync Deployment validation: No ERID support: Yes Mode: Async Deployment validation: YES ERID support: Yes Mode: Async Deployment validation: No
/v1/products/{baseProductId or bbasePaseERID}/retire	ERID support: Yes Mode: Async Deployment validation: No
/v1/products/tasks	ERID support: Yes Mode: Sync Deployment validation: Not applicable
/v1/products/tasks/{taskId}	ERID support: Yes Mode: Sync Deployment validation: Not applicable
/v1/product/tasks?productId={productId)	ERID support: Yes Mode: Sync Deployment validation: Not applicable

Each paired request below performs the same task:

• GET /v1/products/product/variations/{productId or ERID} and GET /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}

• POST /v1/products/product/variations/{productVariationId or variationERID} and POST /v1/products/{productId or ERID}/variations/{productVariationId or variationERID}

• DEL /v1/products/product/variations/{productVariatinId or variatinERID} and DEL /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}