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.

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

Shipstation Integration #5320

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 70 additions & 0 deletions data/saas/config/shipstation_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
saas_config:
fides_key: <instance_fides_key>
name: Shipstation
type: shipstation
description: A sample schema representing the Shipstation connector for Fides
version: 0.1.0

connector_params:
- name: api_key
- name: api_secret

external_references:
- name: customer_id
label: customerId Field
description: The dataset reference to the Shipstation customerId

client_config:
protocol: https
host: ssapi.shipstation.com
authentication:
strategy: basic
configuration:
username: <api_key>
password: <api_secret>

test_request:
method: GET
path: /customers

endpoints:
- name: orders
requests:
read:
method: GET
path: /orders
query_params:
- name: customerName
value: <customer_name>
- name: pageSize
value: "50"
- name: page
value: 1
data_path: orders
postprocessors:
- strategy: filter
configuration:
field: customerEmail
value:
identity: email
pagination:
strategy: offset
configuration:
incremental_param: page
increment_by: 1
param_values:
- name: customer_name
references:
- dataset: <instance_fides_key>
field: customer.name
direction: from
after: ["<instance_fides_key>.customers"]
- name: customer
requests:
read:
method: GET
path: /customers/<customer_id_value>
param_values:
- name: customer_id_value
references:
- customer_id
Loading
Loading