# pmcgee-personal/shipstation-api-partner-sandbox architecture

> Architecture diagram of the GitHub repository pmcgee-personal/shipstation-api-partner-sandbox, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pmcgee-personal/shipstation-api-partner-sandbox
- Repository: https://github.com/pmcgee-personal/shipstation-api-partner-sandbox

## Overview

This repository is a single Bash demo for exercising ShipStation’s partner-to-seller sandbox workflow. A user supplies a partner API key and runs the script; the documented flow creates a seller and warehouse, registers carriers, then generates rates and labels. The only runtime source is `partner-sandbox-demo.sh`. Source excerpts were unavailable, so the stage relationships below rely on the README’s documented sequence rather than inspected implementation details.

Main entry points: [`partner-sandbox-demo.sh`](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh) (Partner demo script)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("Sandbox user"))
node_demo["Partner demo script"]
node_seller["Create seller"]
node_warehouse["Create warehouse"]
node_carriers["Register carriers"]
node_rates["Generate rates"]
node_labels["Generate labels"]
node_api{{"ShipStation API"}}

node_user -->|"runs with key"| node_demo
node_demo -->|"creates"| node_seller
node_seller -->|"then creates"| node_warehouse
node_warehouse -->|"then registers"| node_carriers
node_carriers -->|"then generates"| node_rates
node_rates -->|"then generates"| node_labels
node_demo -->|"exercises flow against"| node_api

click node_demo "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"
click node_seller "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"
click node_warehouse "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"
click node_carriers "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"
click node_rates "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"
click node_labels "https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_user toneBlue
class node_demo,node_seller,node_warehouse,node_carriers,node_rates,node_labels toneTeal
class node_api toneMint
```

## Components

### Other components

- **Sandbox user**
- [Partner demo script](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- [Create seller](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- [Create warehouse](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- [Register carriers](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- [Generate rates](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- [Generate labels](https://github.com/pmcgee-personal/shipstation-api-partner-sandbox/blob/main/partner-sandbox-demo.sh): `partner-sandbox-demo.sh`
- **ShipStation API**

## Connections

- Sandbox user → Partner demo script: runs with key (evidence: `readme.md`)
- Partner demo script → Create seller: creates (evidence: `readme.md`)
- Create seller → Create warehouse: then creates (evidence: `readme.md`)
- Create warehouse → Register carriers: then registers (evidence: `readme.md`)
- Register carriers → Generate rates: then generates (evidence: `readme.md`)
- Generate rates → Generate labels: then generates (evidence: `readme.md`)
- Partner demo script → ShipStation API: exercises flow against (evidence: `readme.md`)