Rest API

Shypyard uses Shopify-api-node as the library to interact with Shopify. Each REST api endpoint is available as function calls.

Method list

  • article

    • authors()

    • count(blogId[, params])

    • create(blogId, params)

    • delete(blogId, id)

    • get(blogId, id[, params])

    • list(blogId[, params])

    • tags([blogId][, params])

    • update(blogId, id, params)

  • asset

    • create(themeId, params)

    • delete(themeId, params)

    • get(themeId, params)

    • list(themeId[, params])

    • update(themeId, params)

  • balance

    • list()

    • transactions([params])

  • blog

    • count()

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • cancellationRequest

    • accept(fulfillmentOrderId[, message])

    • create(fulfillmentOrderId[, message])

    • reject(fulfillmentOrderId[, message])

  • carrierService

    • create(params)

    • delete(id)

    • get(id)

    • list()

    • update(id, params)

  • checkout

    • complete(token)

    • count([params])

    • create(params)

    • get(token)

    • list([params])

    • shippingRates(token)

    • update(token, params)

  • collect

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

  • collection

    • get(id[, params])

    • products(id[, params])

  • collectionListing

    • get(id)

    • list([params])

    • productIds(id[, params])

  • comment

    • approve(id)

    • count([params])

    • create(params)

    • get(id[, params])

    • list([params])

    • notSpam(id)

    • remove(id)

    • restore(id)

    • spam(id)

    • update(id, params)

  • country

    • count()

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • currency

    • list()

  • customCollection

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • customer

    • accountActivationUrl(id)

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • orders(id[, params])

    • search(params)

    • sendInvite(id[, params])

    • update(id, params)

  • customerAddress

    • create(customerId, params)

    • default(customerId, id)

    • delete(customerId, id)

    • get(customerId, id)

    • list(customerId[, params])

    • set(customerId, params)

    • update(customerId, id, params)

  • customerSavedSearch

    • count([params])

    • create(params)

    • customers(id[, params])

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • discountCode

    • create(priceRuleId, params)

    • delete(priceRuleId, id)

    • get(priceRuleId, id)

    • list(priceRuleId)

    • lookup(params)

    • update(priceRuleId, id, params)

  • discountCodeCreationJob

    • create(priceRuleId, params)

    • discountCodes(priceRuleId, id)

    • get(priceRuleId, id)

  • dispute

    • get(id)

    • list([params])

  • draftOrder

    • complete(id[, params])

    • count()

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • sendInvoice(id[, params])

    • update(id, params)

  • event

    • count([params])

    • get(id[, params])

    • list([params])

  • fulfillment

    • cancel(orderId, id)

    • complete(orderId, id)

    • count(orderId[, params)

    • create(orderId, params)

    • createV2(params)

    • get(orderId, id[, params])

    • list(orderId[, params])

    • open(orderId, id)

    • update(orderId, id, params)

    • updateTracking(id, params)

  • fulfillmentEvent

    • create(orderId, fulfillmentId, params)

    • delete(orderId, fulfillmentId, id)

    • get(orderId, fulfillmentId, id)

    • list(orderId, fulfillmentId[, params])

    • update(orderId, fulfillmentId, id, params)

  • fulfillmentOrder

    • cancel(id, params)

    • close(id[, message])

    • get(id)

    • list([params])

    • locationsForMove(id)

    • move(id, locationId)

  • fulfillmentRequest

    • accept(fulfillmentOrderId[, message])

    • create(fulfillmentOrderId, params)

    • reject(fulfillmentOrderId[, message])

  • fulfillmentService

    • create(params)

    • delete(id)

    • get(id)

    • list([params])

    • update(id, params)

  • giftCard

    • count([params])

    • create(params)

    • disable(id)

    • get(id)

    • list([params])

    • search(params)

    • update(id, params)

  • ​giftCardAdjustment​

    • create(giftCardId, params)

    • get(giftCardId, id)

    • list(giftCardId)

  • inventoryItem

    • get(id)

    • list(params)

    • update(id, params)

  • inventoryLevel

    • adjust(params)

    • connect(params)

    • delete(params)

    • list(params)

    • set(params)

  • location

    • count

    • get(id)

    • inventoryLevels(id[, params])

    • list()

  • marketingEvent

    • count()

    • create(params)

    • delete(id)

    • get(id)

    • list([params])

    • update(id, params)

    • engagements(id, params)

  • metafield

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • order

    • cancel(id[, params])

    • close(id)

    • count([params])

    • create(params)

    • delete(id)

    • fulfillmentOrders(id)

    • get(id[, params])

    • list([params])

    • open(id)

    • update(id, params)

  • orderRisk

    • create(orderId, params)

    • delete(orderId, id)

    • get(orderId, id)

    • list(orderId)

    • update(orderId, id, params)

  • page

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • payment

    • count(checkoutToken)

    • create(checkoutToken, params)

    • get(checkoutToken, id)

    • list(checkoutToken)

  • priceRule

    • create(params)

    • delete(id)

    • get(id)

    • list([params])

    • update(id, params)

  • product

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • productImage

    • count(productId[, params])

    • create(productId, params)

    • delete(productId, id)

    • get(productId, id[, params])

    • list(productId[, params])

    • update(productId, id, params)

  • productListing

    • count()

    • create(productId[, params])

    • delete(productId)

    • get(productId)

    • list([params])

    • productIds([params])

  • ​productResourceFeedback​

    • create(productId[, params])

    • list(productId)

  • productVariant

    • count(productId)

    • create(productId, params)

    • delete(productId, id)

    • get(id[, params])

    • list(productId[, params])

    • update(id, params)

  • province

    • count(countryId[, params])

    • get(countryId, id[, params])

    • list(countryId[, params])

    • update(countryId, id, params)

  • redirect

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • refund

    • calculate(orderId, params)

    • create(orderId, params)

    • get(orderId, id[, params])

    • list(orderId[, params])

  • report

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • resourceFeedback

    • create(params)

    • list()

  • scriptTag

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • shippingZone

    • list([params])

  • shop

    • get([params])

  • smartCollection

    • count([params])

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • order(id, params)

    • products(id[, params])

    • update(id, params)

  • tenderTransaction

    • list([params])

  • theme

    • create(params)

    • delete(id)

    • get(id[, params])

    • list([params])

    • update(id, params)

  • transaction

    • count(orderId)

    • create(orderId, params)

    • get(orderId, id[, params])

    • list(orderId[, params])

  • user

    • current()

    • get(id)

    • list()

Resources:

Common actions

Get product data from ID

const productData = await shopify.product.get(product_id);

Update product tags

const newTags = ['tag1', 'tag2', 'tag3'];
await shopify.product.update(id, {
tags: newTags.join(', ');
});

Close order

await shopify.order.close(order_id);