BigCommerce Extractor
Pricing
$30.00/month + usage
Go to Store
BigCommerce Extractor
jupri/bigcommerce
💫 Scrape BigCommerce Websites
0.0 (0)
Pricing
$30.00/month + usage
1
Monthly users
4
Runs succeeded
>99%
Last modified
6 months ago
You can access the BigCommerce Extractor programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "0.0",
5 "x-build-id": "TdkFdP2ykad7VSBho"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/jupri~bigcommerce/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-jupri-bigcommerce",
16 "x-openai-isConsequential": false,
17 "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18 "tags": [
19 "Run Actor"
20 ],
21 "requestBody": {
22 "required": true,
23 "content": {
24 "application/json": {
25 "schema": {
26 "$ref": "#/components/schemas/inputSchema"
27 }
28 }
29 }
30 },
31 "parameters": [
32 {
33 "name": "token",
34 "in": "query",
35 "required": true,
36 "schema": {
37 "type": "string"
38 },
39 "description": "Enter your Apify token here"
40 }
41 ],
42 "responses": {
43 "200": {
44 "description": "OK"
45 }
46 }
47 }
48 },
49 "/acts/jupri~bigcommerce/runs": {
50 "post": {
51 "operationId": "runs-sync-jupri-bigcommerce",
52 "x-openai-isConsequential": false,
53 "summary": "Executes an Actor and returns information about the initiated run in response.",
54 "tags": [
55 "Run Actor"
56 ],
57 "requestBody": {
58 "required": true,
59 "content": {
60 "application/json": {
61 "schema": {
62 "$ref": "#/components/schemas/inputSchema"
63 }
64 }
65 }
66 },
67 "parameters": [
68 {
69 "name": "token",
70 "in": "query",
71 "required": true,
72 "schema": {
73 "type": "string"
74 },
75 "description": "Enter your Apify token here"
76 }
77 ],
78 "responses": {
79 "200": {
80 "description": "OK",
81 "content": {
82 "application/json": {
83 "schema": {
84 "$ref": "#/components/schemas/runsResponseSchema"
85 }
86 }
87 }
88 }
89 }
90 }
91 },
92 "/acts/jupri~bigcommerce/run-sync": {
93 "post": {
94 "operationId": "run-sync-jupri-bigcommerce",
95 "x-openai-isConsequential": false,
96 "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97 "tags": [
98 "Run Actor"
99 ],
100 "requestBody": {
101 "required": true,
102 "content": {
103 "application/json": {
104 "schema": {
105 "$ref": "#/components/schemas/inputSchema"
106 }
107 }
108 }
109 },
110 "parameters": [
111 {
112 "name": "token",
113 "in": "query",
114 "required": true,
115 "schema": {
116 "type": "string"
117 },
118 "description": "Enter your Apify token here"
119 }
120 ],
121 "responses": {
122 "200": {
123 "description": "OK"
124 }
125 }
126 }
127 }
128 },
129 "components": {
130 "schemas": {
131 "inputSchema": {
132 "type": "object",
133 "properties": {
134 "query": {
135 "title": "❓ Query",
136 "type": "array",
137 "description": "💡 Homepage URLs",
138 "items": {
139 "type": "string"
140 }
141 },
142 "limit": {
143 "title": "♾️ Limit",
144 "type": "integer",
145 "description": "💡 Number of results"
146 },
147 "filters.search": {
148 "title": "Search",
149 "type": "string",
150 "description": "💡 Searches against several fields on the product including Name, SKU, and Description"
151 },
152 "filters.sort": {
153 "title": "Sorting",
154 "enum": [
155 "name_asc",
156 "review",
157 "selling",
158 "featured",
159 "price_desc",
160 "price_asc",
161 "newest",
162 "relevance",
163 "name_desc"
164 ],
165 "type": "string",
166 "description": ""
167 },
168 "filters.brand_id": {
169 "title": "Brand ID",
170 "type": "string",
171 "description": "💡 Brand ID must be digits"
172 },
173 "filters.category_id": {
174 "title": "Category ID",
175 "type": "string",
176 "description": "💡 Category ID must be digits"
177 },
178 "filters.min_rating": {
179 "title": "Rating",
180 "type": "integer",
181 "description": ""
182 },
183 "filters.max_rating": {
184 "title": "",
185 "type": "integer",
186 "description": ""
187 },
188 "filters.featured": {
189 "title": "Featured",
190 "type": "boolean",
191 "description": ""
192 },
193 "filters.in_stock": {
194 "title": "In Stock",
195 "type": "boolean",
196 "description": ""
197 },
198 "filters.free_ship": {
199 "title": "Free Shipping",
200 "type": "boolean",
201 "description": ""
202 },
203 "dev_proxy_config": {
204 "title": "🌐 PROXY NETWORKING",
205 "type": "object",
206 "description": "💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
207 },
208 "dev_custom_headers": {
209 "title": "📜 HTTP HEADERS",
210 "type": "array",
211 "description": "💡 Additional HTTP Headers",
212 "items": {
213 "type": "object",
214 "required": [
215 "key",
216 "value"
217 ],
218 "properties": {
219 "key": {
220 "type": "string",
221 "title": "Key"
222 },
223 "value": {
224 "type": "string",
225 "title": "Value"
226 }
227 }
228 }
229 },
230 "dev_custom_cookies": {
231 "title": "🍰 HTTP COOKIES",
232 "type": "array",
233 "description": "💡 Additional HTTP Cookies",
234 "items": {
235 "type": "object",
236 "required": [
237 "key",
238 "value"
239 ],
240 "properties": {
241 "key": {
242 "type": "string",
243 "title": "Key"
244 },
245 "value": {
246 "type": "string",
247 "title": "Value"
248 }
249 }
250 }
251 },
252 "dev_transform_fields": {
253 "title": "♻️ CUSTOM FIELD",
254 "type": "array",
255 "description": "💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>",
256 "items": {
257 "type": "object",
258 "required": [
259 "key",
260 "value"
261 ],
262 "properties": {
263 "key": {
264 "type": "string",
265 "title": "Key"
266 },
267 "value": {
268 "type": "string",
269 "title": "Value"
270 }
271 }
272 }
273 },
274 "dev_dataset_name": {
275 "title": "📁 CUSTOM STORAGE",
276 "type": "string",
277 "description": "💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
278 },
279 "dev_dataset_clear": {
280 "title": "Clear Storage",
281 "type": "boolean",
282 "description": "Clear Dataset before insert/update."
283 },
284 "dev_no_strip": {
285 "title": "Disable data cleansing",
286 "type": "boolean",
287 "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
288 }
289 }
290 },
291 "runsResponseSchema": {
292 "type": "object",
293 "properties": {
294 "data": {
295 "type": "object",
296 "properties": {
297 "id": {
298 "type": "string"
299 },
300 "actId": {
301 "type": "string"
302 },
303 "userId": {
304 "type": "string"
305 },
306 "startedAt": {
307 "type": "string",
308 "format": "date-time",
309 "example": "2025-01-08T00:00:00.000Z"
310 },
311 "finishedAt": {
312 "type": "string",
313 "format": "date-time",
314 "example": "2025-01-08T00:00:00.000Z"
315 },
316 "status": {
317 "type": "string",
318 "example": "READY"
319 },
320 "meta": {
321 "type": "object",
322 "properties": {
323 "origin": {
324 "type": "string",
325 "example": "API"
326 },
327 "userAgent": {
328 "type": "string"
329 }
330 }
331 },
332 "stats": {
333 "type": "object",
334 "properties": {
335 "inputBodyLen": {
336 "type": "integer",
337 "example": 2000
338 },
339 "rebootCount": {
340 "type": "integer",
341 "example": 0
342 },
343 "restartCount": {
344 "type": "integer",
345 "example": 0
346 },
347 "resurrectCount": {
348 "type": "integer",
349 "example": 0
350 },
351 "computeUnits": {
352 "type": "integer",
353 "example": 0
354 }
355 }
356 },
357 "options": {
358 "type": "object",
359 "properties": {
360 "build": {
361 "type": "string",
362 "example": "latest"
363 },
364 "timeoutSecs": {
365 "type": "integer",
366 "example": 300
367 },
368 "memoryMbytes": {
369 "type": "integer",
370 "example": 1024
371 },
372 "diskMbytes": {
373 "type": "integer",
374 "example": 2048
375 }
376 }
377 },
378 "buildId": {
379 "type": "string"
380 },
381 "defaultKeyValueStoreId": {
382 "type": "string"
383 },
384 "defaultDatasetId": {
385 "type": "string"
386 },
387 "defaultRequestQueueId": {
388 "type": "string"
389 },
390 "buildNumber": {
391 "type": "string",
392 "example": "1.0.0"
393 },
394 "containerUrl": {
395 "type": "string"
396 },
397 "usage": {
398 "type": "object",
399 "properties": {
400 "ACTOR_COMPUTE_UNITS": {
401 "type": "integer",
402 "example": 0
403 },
404 "DATASET_READS": {
405 "type": "integer",
406 "example": 0
407 },
408 "DATASET_WRITES": {
409 "type": "integer",
410 "example": 0
411 },
412 "KEY_VALUE_STORE_READS": {
413 "type": "integer",
414 "example": 0
415 },
416 "KEY_VALUE_STORE_WRITES": {
417 "type": "integer",
418 "example": 1
419 },
420 "KEY_VALUE_STORE_LISTS": {
421 "type": "integer",
422 "example": 0
423 },
424 "REQUEST_QUEUE_READS": {
425 "type": "integer",
426 "example": 0
427 },
428 "REQUEST_QUEUE_WRITES": {
429 "type": "integer",
430 "example": 0
431 },
432 "DATA_TRANSFER_INTERNAL_GBYTES": {
433 "type": "integer",
434 "example": 0
435 },
436 "DATA_TRANSFER_EXTERNAL_GBYTES": {
437 "type": "integer",
438 "example": 0
439 },
440 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
441 "type": "integer",
442 "example": 0
443 },
444 "PROXY_SERPS": {
445 "type": "integer",
446 "example": 0
447 }
448 }
449 },
450 "usageTotalUsd": {
451 "type": "number",
452 "example": 0.00005
453 },
454 "usageUsd": {
455 "type": "object",
456 "properties": {
457 "ACTOR_COMPUTE_UNITS": {
458 "type": "integer",
459 "example": 0
460 },
461 "DATASET_READS": {
462 "type": "integer",
463 "example": 0
464 },
465 "DATASET_WRITES": {
466 "type": "integer",
467 "example": 0
468 },
469 "KEY_VALUE_STORE_READS": {
470 "type": "integer",
471 "example": 0
472 },
473 "KEY_VALUE_STORE_WRITES": {
474 "type": "number",
475 "example": 0.00005
476 },
477 "KEY_VALUE_STORE_LISTS": {
478 "type": "integer",
479 "example": 0
480 },
481 "REQUEST_QUEUE_READS": {
482 "type": "integer",
483 "example": 0
484 },
485 "REQUEST_QUEUE_WRITES": {
486 "type": "integer",
487 "example": 0
488 },
489 "DATA_TRANSFER_INTERNAL_GBYTES": {
490 "type": "integer",
491 "example": 0
492 },
493 "DATA_TRANSFER_EXTERNAL_GBYTES": {
494 "type": "integer",
495 "example": 0
496 },
497 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
498 "type": "integer",
499 "example": 0
500 },
501 "PROXY_SERPS": {
502 "type": "integer",
503 "example": 0
504 }
505 }
506 }
507 }
508 }
509 }
510 }
511 }
512 }
513}BigCommerce Scraper OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for BigCommerce Extractor from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Pricing
Pricing model
RentalTo use this Actor, you have to pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period. You also pay for the Apify platform usage.
Free trial
7 days
Price
$30.00
