Spring Seller API

{"info":{"version":"0.0.1"},"swagger":"2.0","produces":["application/json"],"host":"api.teespring.com","basePath":"/","tags":[{"name":"internal","description":"Operations about internals"},{"name":"seller","description":"Operations about sellers"},{"name":"v1","description":"Operations about v1s"}],"paths":{"/internal/v1/stripe/dispute_closed":{"post":{"description":"Register that a dispute was closed.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"data[object][id]","description":"This is the dispute ID","type":"string","required":true},{"in":"formData","name":"data[object][status]","description":"This is the status of the dispute","type":"string","required":true}],"responses":{"201":{"description":"Register that a dispute was closed."}},"tags":["internal"],"operationId":"postInternalV1StripeDisputeClosed"}},"/internal/v1/stripe/dispute_created":{"post":{"description":"Register that a new dispute was created.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"data[object][id]","description":"This is the dispute ID","type":"string","required":true},{"in":"formData","name":"data[object][charge]","description":"This is the charge ID, we use this to find the charge in dispute","type":"string","required":true},{"in":"formData","name":"data[object][status]","description":"This is the status of the dispute","type":"string","required":true},{"in":"formData","name":"data[object][reason]","description":"This is the reason of the dispute","type":"string","required":false}],"responses":{"201":{"description":"Register that a new dispute was created."}},"tags":["internal"],"operationId":"postInternalV1StripeDisputeCreated"}},"/seller/v1/messages/variables":{"get":{"description":"Message template variables","produces":["application/json"],"responses":{"200":{"description":"Message template variables"}},"tags":["seller"],"operationId":"getSellerV1MessagesVariables"}},"/seller/v1/messages/send":{"post":{"description":"Send a message to buyer(s)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"formData","name":"email_type_id","type":"string","required":true},{"in":"formData","name":"subject","type":"string","required":true},{"in":"formData","name":"content","type":"string","required":true}],"responses":{"201":{"description":"Send a message to buyer(s)"}},"tags":["seller"],"operationId":"postSellerV1MessagesSend"}},"/seller/v1/messages/recipients":{"get":{"description":"Get information about sending a message to buyer(s)","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"slug","type":"string","required":false},{"in":"query","name":"lookup_number","type":"string","required":false}],"responses":{"200":{"description":"Get information about sending a message to buyer(s)"}},"tags":["seller"],"operationId":"getSellerV1MessagesRecipients"}},"/seller/v1/summary":{"get":{"produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"period","description":["today","yesterday","week","month","seven_days","thirty_days"],"type":"string","required":true},{"in":"query","name":"slug","description":"campaign root slug","type":"string","required":false},{"in":"query","name":"flush_cache","description":"Whether or not to flush the cache. Defaults to false.","type":"boolean","required":false}],"responses":{"200":{"description":""}},"tags":["seller"],"operationId":"getSellerV1Summary"}},"/seller/v1/promotions":{"get":{"summary":"Promo codes the seller has defined","description":"\n\nSeller's promo codes.","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Promo codes the seller has defined"}},"tags":["seller"],"operationId":"getSellerV1Promotions"}},"/seller/v1/payouts":{"get":{"summary":"Payouts from Teespring","description":"\n\nSeller's payout history, including requests and actual payouts.","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Payouts from Teespring"}},"tags":["seller"],"operationId":"getSellerV1Payouts"}},"/seller/v1/dashboard/volume_discount":{"get":{"description":"Information about volume discounts","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true}],"responses":{"200":{"description":"Information about volume discounts"}},"tags":["seller"],"operationId":"getSellerV1DashboardVolumeDiscount"}},"/seller/v1/dashboard":{"get":{"summary":"All the information shown on the seller dashboard","description":"\n\nAll the information used to populate the Seller Dashboard, pulled from exactly the same source.","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true}],"responses":{"200":{"description":"All the information shown on the seller dashboard"}},"tags":["seller"],"operationId":"getSellerV1Dashboard"}},"/seller/v1/orders/for_buyer_from_order/{lookup_number}":{"get":{"description":"Orders placed by a single user","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"query","name":"states","description":"comma-separated list of order states (failed, cancelled_and_refunded, cancelled, initialized, placed, charged) (default: placed,charged)","type":"string","required":false},{"in":"path","name":"lookup_number","description":"order lookup number","type":"string","required":true}],"responses":{"200":{"description":"Orders placed by a single user"}},"tags":["seller"],"operationId":"getSellerV1OrdersForBuyerFromOrderLookupNumber"}},"/seller/v1/orders":{"get":{"summary":"Orders placed on campaigns","description":"\n\nAll lifetime orders and line items for the authenticated seller, including information about the purchase and buyer.","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"query","name":"states","description":"comma-separated list of order states (failed, cancelled_and_refunded, cancelled, initialized, placed, charged) (default: placed,charged)","type":"string","required":false},{"in":"query","name":"campaign_ids","description":"A comma-separated list of campaign ids. Only orders belonging to the provided campaigns will be returned. Default: *","type":"string","required":false},{"in":"query","name":"start_date","description":"A date in the format YYYY-MM-DD. Only return orders on or after this date.","type":"string","required":false},{"in":"query","name":"end_date","description":"A date in the format YYYY-MM-DD. Only return orders on or before this date.","type":"string","required":false}],"responses":{"200":{"description":"Orders placed on campaigns"}},"tags":["seller"],"operationId":"getSellerV1Orders"}},"/seller/v1/campaigns/{slug}":{"get":{"summary":"Specific campaign root, named by the \"slug\" (unique identifier in the url) e.g. freefishco","description":"\n\nA single campaign root and all of its associated campaigns, given by the \"slug\" (the part of the URL that is unique to your campaign).","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"path","name":"slug","description":"unique identifier in the campaign's url","type":"string","required":true},{"in":"query","name":"history","description":"include previous runs","type":"boolean","required":false},{"in":"query","name":"getvars","description":"include GET variables data","type":"boolean","required":false}],"responses":{"200":{"description":"Specific campaign root, named by the \"slug\" (unique identifier in the url) e.g. freefishco"}},"tags":["seller"],"operationId":"getSellerV1CampaignsSlug"}},"/seller/v1/campaigns":{"get":{"summary":"All campaign roots","description":"\n\nAll the campaign roots for the authenticated user. Campaign roots are groupings of individual campaign \"runs\" for a single design. When you create a campaign in the Composer, you are actually creating a campaign root and an attached campaign. Every time a campaign is relaunched, an additional campaign is added to that campaign root. So every design has a campaign root, and one more campaigns.","produces":["application/json"],"parameters":[{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"query","name":"search","description":"search term to filter only records with a matching title or description","type":"string","required":false},{"in":"query","name":"states","description":"comma-separated list of campaign states (deleted, draft, active, suspended, success, failed, archive, redirect, hidden)","type":"string","required":false},{"in":"query","name":"sort_by_sales","description":"sort by sales in high to low (desc) or low to high (asc)","type":"string","required":false},{"in":"query","name":"sort_by_profit","description":"sort by profit in high to low (desc) or low to high (asc)","type":"string","required":false},{"in":"query","name":"recency","description":"sort by most/least recent campaigns","type":"string","required":false},{"in":"query","name":"slug","description":"Unique identifier in the campaign's url. Providing this will cause the api to only return one campaign.","type":"string","required":false},{"in":"query","name":"campaign_id","description":"ID of one of the campaign root's campaigns. Providing this will cause the api to only return one campaign.","type":"integer","format":"int32","required":false},{"in":"query","name":"history","description":"Include previous runs (only if specifying either slug or campaign_id)","type":"boolean","required":false},{"in":"query","name":"getvars","description":"Include GET variables data (only if specifying either slug or campaign_id)","type":"boolean","required":false}],"responses":{"200":{"description":"All campaign roots"}},"tags":["seller"],"operationId":"getSellerV1Campaigns"}},"/v1/users/me/saved-addresses":{"get":{"produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true}],"responses":{"200":{"description":"get SavedAddress(s)"}},"tags":["v1"],"operationId":"getV1UsersMeSavedAddresses"}},"/v1/users/me/saved-cards":{"get":{"produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true}],"responses":{"200":{"description":"get SavedCard(s)"}},"tags":["v1"],"operationId":"getV1UsersMeSavedCards"}},"/v1/users/me":{"get":{"description":"Returns the currently authenticated user","produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"access_token","description":"authentication token obtained from the V1 Auth API","type":"string","required":true}],"responses":{"200":{"description":"Returns the currently authenticated user"}},"tags":["v1"],"operationId":"getV1UsersMe"}},"/v1/search-suggestions/trending":{"get":{"description":"Get trending search results","produces":["application/json"],"responses":{"200":{"description":"Get trending search results"}},"tags":["v1"],"operationId":"getV1SearchSuggestionsTrending"}},"/v1/rush-prices/{campaign_region_name}":{"get":{"description":"GET active RushPrice offers in CampaignRegion","produces":["application/json"],"parameters":[{"in":"query","name":"country_id","description":"Country ID, for filtering","type":"string","required":false},{"in":"path","name":"campaign_region_name","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"GET active RushPrice offers in CampaignRegion"}},"tags":["v1"],"operationId":"getV1RushPricesCampaignRegionName"}},"/v1/recommenders/{recommender_id}/campaigns":{"get":{"summary":"Paginated collection of campaigns produced by a recommender","description":"\n\nFetches a paginated collection of campaigns produced by a recommender.","produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"path","name":"recommender_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Paginated collection of campaigns produced by a recommender"}},"tags":["v1"],"operationId":"getV1RecommendersRecommenderIdCampaigns"}},"/v1/categories/{slug}/campaigns":{"get":{"summary":"All campaigns in a category","description":"\n\nFetches all the campaigns within the specified category.","produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"path","name":"slug","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"All campaigns in a category"}},"tags":["v1"],"operationId":"getV1CategoriesSlugCampaigns"}},"/v1/categories/{slug}":{"get":{"description":"Get category metdata","produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"page","description":"page number to view","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"number of records per page","type":"integer","format":"int32","required":false},{"in":"query","name":"include_campaigns","description":"Also include active campaigns","type":"boolean","required":false},{"in":"path","name":"slug","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get category metdata"}},"tags":["v1"],"operationId":"getV1CategoriesSlug"}},"/v1/campaigns/{slug}":{"get":{"produces":["application/json"],"parameters":[{"in":"query","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"query","name":"currency","description":"The currency to use for pricing","type":"string","required":false},{"in":"path","name":"slug","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"get Campaign(s)"}},"tags":["v1"],"operationId":"getV1CampaignsSlug"}},"/v1/auth-tokens":{"post":{"summary":"Logs in a user and returns an OAuth token","description":"\n\nMake the below request using your Teespring email and password, along with the `app_id` provided to you by Teespring. Copy the access token from the response and include it as the access_token url parameter for all subsequent requests. The token will expire after 24 hours and require a new request. Never share your access token with anyone. It will allow them to access your Teespring data until it expires.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"app_id","description":"app ID (provided by Teespring)","type":"string","required":true},{"in":"formData","name":"email","description":"Teespring e-mail address","type":"string","required":false},{"in":"formData","name":"password","description":"Teespring password","type":"string","required":false}],"responses":{"201":{"description":"Logs in a user and returns an OAuth token"}},"tags":["v1"],"operationId":"postV1AuthTokens"}}}}