examples/api-examples.json

{
  "notice": "Offline schema fixtures only. Illustrative IDs/tracking. Never execute these requests against Etsy. Real reads, facts and authorization required.",
  "examples": [
    {
      "tool": "etsy_get_me",
      "arguments": {}
    },
    {
      "tool": "etsy_get_listing",
      "arguments": {
        "listing_id": 1234567890
      }
    },
    {
      "tool": "etsy_get_listings_by_shop",
      "arguments": {
        "state": "draft",
        "limit": 25,
        "offset": 0
      }
    },
    {
      "tool": "etsy_get_shop_shipping_profiles",
      "arguments": {}
    },
    {
      "tool": "etsy_get_seller_taxonomy_nodes",
      "arguments": {}
    },
    {
      "tool": "etsy_get_properties_by_taxonomy_id",
      "arguments": {
        "taxonomy_id": 123
      }
    },
    {
      "tool": "etsy_create_draft_listing",
      "arguments": {
        "confirm": true,
        "body": {
          "quantity": 5,
          "title": "Personalized Acrylic Desk Sign with Wooden Stand, Custom Engraved Name",
          "description": "Create a clear, personal place on your desk with a custom engraved acrylic name sign. Its minimalist layout keeps your chosen name easy to read, and the included wooden stand holds the sign upright.\n\nWHAT YOU RECEIVE\nOne clear acrylic sign measuring 8 \u00d7 3 inches and one wooden stand. Decorative items in styled photos are not included.\n\nPERSONALIZATION\nEnter the name exactly as you want it engraved, including capitalization. Maximum 24 characters. Example: Olivia. Check spelling before ordering.\n\nDETAILS\nClear acrylic sign with a wooden stand. Minimalist engraved name. Sign size: 8 \u00d7 3 inches, excluding the stand.\n\nPROCESSING AND SHIPPING\nMade to order and dispatched from the United States in 3\u20135 business days. Shipping within the United States costs $5. Carrier transit is separate from processing; an arrival date has not been confirmed.\n\nRETURNS\nReturns and exchanges are not offered under this seller's selected shop policy. Contact the seller about an order issue.",
          "price": 29,
          "who_made": "i_did",
          "when_made": "made_to_order",
          "taxonomy_id": 123,
          "type": "physical",
          "tags": [
            "custom desk sign",
            "personalized sign",
            "acrylic name plate",
            "office desk sign",
            "desk name plaque",
            "teacher desk sign",
            "work desk decor",
            "office name plaque",
            "engraved desk sign",
            "desk sign stand",
            "custom name plate",
            "minimalist sign",
            "teacher name plate"
          ],
          "materials": [
            "acrylic",
            "wood"
          ]
        }
      }
    },
    {
      "tool": "etsy_update_listing",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "title": "Personalized Acrylic Desk Sign with Wooden Stand, Custom Engraved Name"
        }
      }
    },
    {
      "tool": "etsy_update_listing",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "shipping_profile_id": 1234567
        }
      }
    },
    {
      "tool": "etsy_update_listing",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "return_policy_id": 2345678
        }
      }
    },
    {
      "tool": "etsy_update_shop_shipping_profile_destination",
      "arguments": {
        "shipping_profile_id": 1234567,
        "shipping_profile_destination_id": 7654321,
        "confirm": true,
        "body": {
          "primary_cost": 5,
          "secondary_cost": 2
        }
      }
    },
    {
      "tool": "etsy_create_shop_readiness_state_definition",
      "arguments": {
        "confirm": true,
        "body": {
          "readiness_state": "made_to_order",
          "min_processing_time": 3,
          "max_processing_time": 5,
          "processing_time_unit": "days"
        }
      }
    },
    {
      "tool": "etsy_update_listing_personalization",
      "arguments": {
        "listing_id": 1234567890,
        "supports_multiple_personalization_questions": true,
        "confirm": true,
        "body": {
          "personalization_questions": [
            {
              "question_text": "Name for your sign",
              "question_type": "text_input",
              "required": true,
              "max_allowed_characters": 24
            }
          ]
        }
      }
    },
    {
      "tool": "etsy_delete_listing_personalization",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true
      }
    },
    {
      "tool": "etsy_update_listing_inventory",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "products": [
            {
              "sku": "EXAMPLE-DESK-01",
              "property_values": [],
              "offerings": [
                {
                  "price": 29,
                  "quantity": 5,
                  "is_enabled": true,
                  "readiness_state_id": 123456
                }
              ]
            }
          ],
          "price_on_property": [],
          "quantity_on_property": [],
          "sku_on_property": []
        }
      }
    },
    {
      "tool": "etsy_upload_listing_image",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "image": {
            "asset_id": 12,
            "filename": "sign.jpg"
          },
          "rank": 1,
          "alt_text": "Clear acrylic name sign in a wooden stand, viewed from the front."
        }
      }
    },
    {
      "tool": "etsy_upload_listing_file",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "file": {
            "asset_id": 13,
            "filename": "weekly-a4.pdf"
          },
          "name": "weekly-a4.pdf",
          "rank": 1
        }
      }
    },
    {
      "tool": "etsy_upload_listing_video",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "is_multi_video": true,
        "body": {
          "video": {
            "asset_id": 14,
            "filename": "sign.mp4"
          },
          "name": "sign.mp4"
        }
      }
    },
    {
      "tool": "etsy_create_receipt_shipment",
      "arguments": {
        "receipt_id": 123456789,
        "confirm": true,
        "body": {
          "tracking_code": "EXAMPLE-NOT-REAL",
          "carrier_name": "EXAMPLE-NOT-REAL"
        }
      }
    },
    {
      "tool": "etsy_update_listing",
      "arguments": {
        "listing_id": 1234567890,
        "confirm": true,
        "body": {
          "state": "active"
        }
      }
    },
    {
      "tool": "etsy_token_scopes",
      "arguments": {}
    }
  ]
}