Read an Etsy shop and its profiles again

POST

/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/etsy/shop/refresh

const url = 'https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/etsy/shop/refresh';
const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/etsy/shop/refresh \
  --header 'x-api-key: <x-api-key>'

After the merchant creates or edits shipping or processing profiles on Etsy. The listing setup is kept.

Authorizations

api_key
cookie
bearer

Parameters

Path Parameters

workspaceId

required

string

connectionId

required

string

Responses

200

application/json

object

required

string format: uuid

channel

required

string

Allowed values: shopify ebay google_merchant etsy amazon walmart

externalAccountId

required

The account on the channel

string

displayName

required

string

status

required

string

Allowed values: CONNECTED NEEDS_REAUTH DISCONNECTED ERROR

statusReason

required

Why it needs re-auth or failed

string

nullable

grantedScopes

required

Array<string>

missingFeatures

required

What the connection cannot do until the merchant approves the app again

Array<string>

Allowed values: storefront_visibility order_sync

shopify

required

The store’s details, for Shopify connections

object

shopName

required

string

currencyCode

required

ISO 4217 code of the store’s currency

string

ianaTimezone

required

string

nullable

primaryDomainUrl

required

The storefront’s public URL

string

nullable

primaryLocation

required

Where Crossmart reads and writes stock

object

required

string

name

required

string

ebay

required

The account’s details on its marketplace, for eBay connections

object

marketplaceId

required

string

Allowed values: EBAY_US EBAY_GB EBAY_DE EBAY_AU EBAY_CA EBAY_FR EBAY_IT EBAY_ES

currencyCode

required

ISO 4217 code of the marketplace’s currency

string

username

required

string

userId

required

EBay’s immutable id of the user

string

businessPoliciesEnabled

required

False when the account has not opted in to business policies on eBay

boolean

policies

required

object

fulfillment

required

Array<object>

object

required

string

name

required

string

payment

required

Array<object>

object

required

string

name

required

string

return

required

Array<object>

object

required

string

name

required

string

listingDefaults

required

What listings are published with; policies resolve to the only one of a type

object

fulfillmentPolicyId

required

string

nullable

paymentPolicyId

required

string

nullable

returnPolicyId

required

string

nullable

condition

required

string

Allowed values: NEW LIKE_NEW NEW_OTHER NEW_WITH_DEFECTS CERTIFIED_REFURBISHED EXCELLENT_REFURBISHED VERY_GOOD_REFURBISHED GOOD_REFURBISHED SELLER_REFURBISHED USED_EXCELLENT USED_VERY_GOOD USED_GOOD USED_ACCEPTABLE FOR_PARTS_OR_NOT_WORKING

location

required

object

postalCode

required

string

country

required

ISO 3166 alpha-2 country code

string

city

required

string

nullable

merchantLocationKey

required

The inventory location Crossmart created on eBay for location

string

nullable

readyToList

required

Whether listings can be published: policies of each type and a ship-from set

boolean

googleMerchant

required

The Merchant Center account and its listing setup, for Google connections

object

accountId

required

string

accountName

required

string

homepageUri

required

The website the account claimed; product links must be on it

string

nullable

homepageClaimed

required

Whether the account verified and claimed its website

boolean

country

required

string

Allowed values: US GB CA AU DE FR IT ES NL IL

currencyCode

required

ISO 4217 code of the country’s currency

string

contentLanguage

required

The language listings are written in

string

listingSetup

required

Null until the merchant saves it; publishing needs it

object

country

required

string

Allowed values: US GB CA AU DE FR IT ES NL IL

productUrlTemplate

required

string

dataSourceId

required

The Merchant Center API data source Crossmart publishes into

string

readyToList

required

Whether the listing setup is saved, so products can be listed

boolean

etsy

required

The Etsy shop, its profiles and its listing setup, for Etsy connections

object

shopId

required

string

shopName

required

string

currencyCode

required

ISO 4217 code of the shop’s currency

string

shopUrl

required

string

nullable

profiles

required

object

shipping

required

Array<object>

object

required

string

name

required

string

processing

required

Processing profiles: whether items are ready to ship or made to order, and how long they take

Array<object>

object

required

string

name

required

string

listingSetup

required

Null until the merchant saves it; publishing needs it

object

whoMade

required

string

Allowed values: i_did someone_else collective

whenMade

required

string

Allowed values: made_to_order 2020_2026 2010_2019 2007_2009 before_2007 2000_2006 1990s 1980s 1970s 1960s 1950s 1940s 1930s 1920s 1910s 1900s 1800s 1700s before_1700

isSupply

required

Whether the items are craft supplies rather than finished products

boolean

shippingProfileId

required

The shipping profile listings use; null when the shop has none or several and none is chosen

string

nullable

processingProfileId

required

The processing profile listings use

string

nullable

readyToList

required

Whether the listing setup is complete, so products can be listed

boolean

productSelection

required

Which products the connection lists; null lists every product

object

filter

required

object

search

Matches title, handle or SKU

string

status

string

Allowed values: DRAFT ACTIVE ARCHIVED

gap

string

Allowed values: images description sku barcode out_of_stock

tags

Products with any of these tags

Array<string>

vendor

Products of this vendor, ignoring case

string

includeProductIds

required

Array<string>

excludeProductIds

required

Array<string>

pricing

required

How the connection prices variants; null sends catalog prices

object

adjustmentPercent

required

Markup (positive) or discount (negative), -90 to 500

string

fixedAmount

required

Added after the percentage; may be negative

string

rounding

required

string

Allowed values: none ending_99 ending_95 whole

floor

required

object

minMarginPercent

required

Never price below cost plus this percentage (0 to 1000)

string

compareAt

required

string

Allowed values: adjust keep omit

fixedExchangeRate

Store-currency units per catalog-currency unit, used instead of the ECB daily rate. Only applies when the store sells in another currency than the workspace.

string

nullable

connectedAt

required

string format: date-time

disconnectedAt

required

string format: date-time

nullable

lastSyncedAt

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

failedListings

required

Listings in this store whose last sync failed

number

publishReadiness

required

Whether listings can be published here, and what the store setup lacks

object

ready

required

True when listings can be published to this store

boolean

missing

required

What to finish before publishing, in order; empty when ready. reconnect alone when the store needs to be connected again. eBay: shipping_policy, payment_policy, return_policy, ship_from_location. Google: listing_setup. Etsy: item_details, shipping_profile, processing_profile. account_settings when the account was never read.

Array<string>

Allowed values: reconnect account_settings shipping_policy payment_policy return_policy ship_from_location listing_setup item_details shipping_profile processing_profile images active_product category item_specifics option_names

Example

{
  "channel": "shopify",
  "externalAccountId": "demo-store.myshopify.com",
  "displayName": "Demo Store",
  "status": "CONNECTED",
  "missingFeatures": [
    "storefront_visibility"
  ],
  "shopify": {
    "currencyCode": "USD",
    "ianaTimezone": "America/New_York",
    "primaryLocation": {
      "id": "gid://shopify/Location/1001"
    }
  },
  "ebay": {
    "marketplaceId": "EBAY_US",
    "currencyCode": "USD",
    "username": "demo_seller",
    "policies": {
      "fulfillment": [
        {
          "id": "6000000001",
          "name": "Free shipping"
        }
      ],
      "payment": [
        {
          "id": "6000000001",
          "name": "Free shipping"
        }
      ],
      "return": [
        {
          "id": "6000000001",
          "name": "Free shipping"
        }
      ]
    },
    "listingDefaults": {
      "condition": "NEW",
      "location": {
        "postalCode": "95125",
        "country": "US",
        "city": "San Jose"
      }
    }
  },
  "googleMerchant": {
    "accountId": "123456789",
    "accountName": "Acme Goods",
    "country": "US",
    "currencyCode": "USD",
    "contentLanguage": "en",
    "listingSetup": {
      "country": "US",
      "productUrlTemplate": "https://acme.example/products/{handle}"
    }
  },
  "etsy": {
    "shopId": "87654321",
    "shopName": "ClayAndKiln",
    "currencyCode": "USD",
    "shopUrl": "https://www.etsy.com/shop/ClayAndKiln",
    "profiles": {
      "shipping": [
        {
          "id": "6722757781",
          "name": "Free US shipping"
        }
      ],
      "processing": [
        {
          "id": "6722757781",
          "name": "Free US shipping"
        }
      ]
    },
    "listingSetup": {
      "whoMade": "i_did",
      "whenMade": "made_to_order"
    }
  },
  "productSelection": {
    "filter": {
      "status": "DRAFT",
      "gap": "images"
    }
  },
  "pricing": {
    "adjustmentPercent": "15",
    "fixedAmount": "0",
    "rounding": "none",
    "floor": {
      "minMarginPercent": "30"
    },
    "compareAt": "adjust",
    "fixedExchangeRate": "0.92"
  },
  "publishReadiness": {
    "missing": [
      "shipping_policy",
      "ship_from_location"
    ]
  }
}