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}

Actions: GET Mode: Sync

/v1/customers/{customerId}/requestPIIRemoval

Actions: POST Mode: Sync

File management

Path
Details

/files/{fileId}/content

Action: GET

Mode: Sync

Order management

Path
Details

/v1/orders/{orderId}

Action: GET

Mode: Sync

/v1/orders/{orderId}/invoices

Action: GET

Mode: Sync

/v1/orders/{orderId}/invoices/{receiptId}

Action: GET

Mode: Sync

Refund management

Path
Details

/orders/{orderId}/refunds

Action: GET

Action: POST

Mode: Sync

/orders/{orderid}/refunds/schema

Action: GET

Mode: Sync

/orders/{orderId}/refunds-available

Action: GET

Action: GET

Mode: Sync

Subscription management

Path
Details

/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

Path
Details

/v1/sites/{siteId}/authorized-billing-countries

Action: GET

Mode: Sync

Deployment validation: No

/v1/sites/{siteId}/authorized-shipping-countries

Action: GET

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

Action: POST

ERID support: Yes

Mode: Async

Deployment validation: Yes

/v1/products/{baseProductId or baseERID}

Action: GET

  • ERID support: Yes

  • Mode: Sync

  • Deployment validation: No

Action: POST

  • ERID support: Yes

  • Mode: Async

  • Deployment validation: Yes

/v1/products/{baseProductId or baseERID}/locales/{locale}

Action: GET

  • ERID support: Yes

  • Mode: Sync

  • Deployment validation: No

Action: POST

  • ERID support: Yes

  • Mode: Async

  • Deployment validation: Yes

Action: DEL

  • 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}

Action: GET

ERID support: Yes

Mode: Sync

Deployment validation: No

/v1/products/{baseProductId or baseERID}/deploy

Action: POST

ERID support: Yes

Mode: Async

Deployment validation: Yes

/v1/products/{baseProductId or baseERID}/live-changes

Action: POST

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

Action: POST

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}

Action: GET

  • ERID support: Yes

  • Mode: Sync

  • Deployment validation: No

Action: POST

  • ERID support: Yes

  • Mode: Async

  • Deployment validation: YES

Action: DEL

  • ERID support: Yes

  • Mode: Async

  • Deployment validation: No

/v1/products/{baseProductId or bbasePaseERID}/retire

Action: POST

ERID support: Yes

Mode: Async

Deployment validation: No

/v1/products/tasks

Action: GET

ERID support: Yes

Mode: Sync

Deployment validation: Not applicable

/v1/products/tasks/{taskId}

Action: GET

ERID support: Yes

Mode: Sync

Deployment validation: Not applicable

/v1/product/tasks?productId={productId)

Action: GET

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}

Last updated