{ "opencollection": "1.0.0", "info": { "name": "Etsy Open API v3 BuyerTaxonomy Shop Receipt API", "version": "3.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Shop Receipt", "type": "folder" }, "items": [ { "info": { "name": "Etsy Get Shop Receipt", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.etsy.com/v3/application/shops/:shop_id/receipts/:receipt_id", "params": [ { "name": "shop_id", "value": "123456", "type": "path", "description": "The unique positive non-zero numeric ID for an Etsy Shop." }, { "name": "receipt_id", "value": "234567890", "type": "path", "description": "The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction." }, { "name": "legacy", "value": "true", "type": "query", "description": "This parameter needed to enable new parameters and response values related to processing profiles." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "
General ReleaseReport bug

This endpoint is ready for production use.

\n\nRetrieves a re" }, { "info": { "name": "Etsy Update Shop Receipt", "type": "http" }, "http": { "method": "PUT", "url": "https://openapi.etsy.com/v3/application/shops/:shop_id/receipts/:receipt_id", "params": [ { "name": "shop_id", "value": "123456", "type": "path", "description": "The unique positive non-zero numeric ID for an Etsy Shop." }, { "name": "receipt_id", "value": "234567890", "type": "path", "description": "The numeric ID for the [receipt](/documentation/reference#tag/Shop-Receipt) associated to this transaction." }, { "name": "legacy", "value": "true", "type": "query", "description": "This parameter needed to enable new parameters and response values related to processing profiles." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "was_shipped", "value": "" }, { "name": "was_paid", "value": "" } ] }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "
General ReleaseReport bug

This endpoint is ready for production use.

\n\nUpdates the st" }, { "info": { "name": "Etsy Get Shop Receipts", "type": "http" }, "http": { "method": "GET", "url": "https://openapi.etsy.com/v3/application/shops/:shop_id/receipts", "params": [ { "name": "shop_id", "value": "123456", "type": "path", "description": "The unique positive non-zero numeric ID for an Etsy Shop." }, { "name": "min_created", "value": "1", "type": "query", "description": "The earliest unix timestamp for when a record was created." }, { "name": "max_created", "value": "1", "type": "query", "description": "The latest unix timestamp for when a record was created." }, { "name": "min_last_modified", "value": "1", "type": "query", "description": "The earliest unix timestamp for when a record last changed." }, { "name": "max_last_modified", "value": "1", "type": "query", "description": "The latest unix timestamp for when a record last changed." }, { "name": "limit", "value": "25", "type": "query", "description": "The maximum number of results to return." }, { "name": "offset", "value": "0", "type": "query", "description": "The number of records to skip before selecting the first result." }, { "name": "sort_on", "value": "created", "type": "query", "description": "The value to sort a search result of listings on." }, { "name": "sort_order", "value": "asc", "type": "query", "description": "The ascending(up) or descending(down) order to sort receipts by." }, { "name": "was_paid", "value": "true", "type": "query", "description": "When `true`, returns receipts where the seller has received payment for the receipt. When `false`, returns receipts where payment has not been received." }, { "name": "was_shipped", "value": "true", "type": "query", "description": "When `true`, returns receipts where the seller shipped the product(s) in this receipt. When `false`, returns receipts where shipment has not been set." }, { "name": "was_delivered", "value": "true", "type": "query", "description": "When `true`, returns receipts that have been marked as delivered. When `false`, returns receipts where shipment has not been marked as delivered." }, { "name": "was_canceled", "value": "true", "type": "query", "description": "When `true`, the endpoint will only return the canceled receipts. When `false`, the endpoint will only return non-canceled receipts." }, { "name": "legacy", "value": "true", "type": "query", "description": "This parameter needed to enable new parameters and response values related to processing profiles." } ], "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "
General ReleaseReport bug

This endpoint is ready for production use.

\n\nRequests the S" }, { "info": { "name": "Etsy Create Receipt Shipment", "type": "http" }, "http": { "method": "POST", "url": "https://openapi.etsy.com/v3/application/shops/:shop_id/receipts/:receipt_id/tracking", "params": [ { "name": "shop_id", "value": "123456", "type": "path", "description": "The unique positive non-zero numeric ID for an Etsy Shop." }, { "name": "receipt_id", "value": "234567890", "type": "path", "description": "The receipt to submit tracking for." }, { "name": "legacy", "value": "true", "type": "query", "description": "This parameter needed to enable new parameters and response values related to processing profiles." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "docs": "
General ReleaseReport bug

This endpoint is ready for production use.

\n\nSubmits tracki" } ] } ], "bundled": true }