Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requested changes, downloading exports, filtering and order exports #648

Merged
merged 5 commits into from
Jan 22, 2024
Merged

Requested changes, downloading exports, filtering and order exports #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d9a6fb9
Update OpenAPI.json
p-zielinski Jan 18, 2024
268dfae
Update OpenAPI.json
p-zielinski Jan 18, 2024
538ae11
exports
p-zielinski Jan 19, 2024
718de58
added descriptions to md files
p-zielinski Jan 19, 2024
eea9391
requested changes
p-zielinski Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ order: 1
---

## Async Action Object
#### This is an object representing an asynchronous action.
| Attributes | Description |
|:-----|:--------|
| id</br>`string` | <p>Async action unique ID.</p> **Example:** <p>aa_0adad13d6f057f088e</p> |
Expand All @@ -23,6 +24,7 @@ order: 1
| object</br>`string` | <p>The type of object represented by JSON. This object stores information about the <code>async_action</code>.</p> |

## CAMPAIGN.VOUCHERS_IMPORT
#### Result schema for a CAMPAIGN.VOUCHERS_IMPORT async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -31,6 +33,7 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CAMPAIGN.VOUCHERS_IMPORT_CSV
#### Result schema for a CAMPAIGN.VOUCHERS_IMPORT_CSV async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -39,30 +42,35 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CAMPAIGN.VOUCHERS_UPDATE
#### Result schema for a CAMPAIGN.VOUCHERS_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGN.VOUCHERS_DELETE
#### Result schema for a CAMPAIGN.VOUCHERS_DELETE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGN.VOUCHERS_GENERATE
#### Result schema for a CAMPAIGN.VOUCHERS_GENERATE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGNS.METADATA_KEY_PURGE
#### Result schema for a CAMPAIGNS.METADATA_KEY_PURGE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CUSTOMERS.IMPORT_CSV
#### Result schema for a CUSTOMERS.IMPORT_CSV async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -71,36 +79,42 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CUSTOMERS.BULK_UPDATE
#### Result schema for a CUSTOMERS.BULK_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique customer <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number or resources processed successfully.</p> |

## CUSTOMERS.METADATA_UPDATE
#### Result schema for a CUSTOMERS.METADATA_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique customer <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CUSTOMERS.METADATA_KEY_PURGE
#### Result schema for a CUSTOMERS.METADATA_KEY_PURGE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.BULK_UPDATE
#### Result schema for a PRODUCTS.BULK_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique product <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.METADATA_UPDATE
#### Result schema for a PRODUCTS.METADATA_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique product <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.IMPORT_CSV
#### Result schema for a PRODUCTS.IMPORT_CSV async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -109,6 +123,7 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## SKUS.IMPORT_CSV
#### Result schema for a SKUS.IMPORT_CSV async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> **Example:** <p>2 sku(s) imported successfully, 6 failed.</p> |
Expand All @@ -117,12 +132,14 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## PRODUCTS.METADATA_KEY_PURGE
#### Result schema for a PRODUCTS.METADATA_KEY_PURGE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources updated successfully.</p> |

## VOUCHERS.IMPORT
#### Result schema for a VOUCHERS.IMPORT async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -131,6 +148,7 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## VOUCHERS.IMPORT_CSV
#### Result schema for a VOUCHERS.IMPORT_CSV async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -139,24 +157,28 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## VOUCHERS.BULK_UPDATE
#### Result schema for a VOUCHERS.BULK_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">code</br><code>string</code></td><td style="text-align:left"><p>Unique voucher code.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## VOUCHERS.METADATA_UPDATE
#### Result schema for a VOUCHERS.METADATA_UPDATE async action type.
| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">code</br><code>string</code></td><td style="text-align:left"><p>Unique voucher code.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## VOUCHERS.METADATA_KEY_PURGE
#### Result schema for a VOUCHERS.METADATA_KEY_PURGE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## ORDERS.IMPORT
#### Result schema for a ORDERS.IMPORT async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand All @@ -165,6 +187,7 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## ORDERS.METADATA_KEY_PURGE
#### Result schema for a ORDERS.METADATA_KEY_PURGE async action type.
| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
Expand Down
Loading