ShipStation

Use the @bijection/connectors/shipstation entrypoint to declare ShipStation resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Orders	`pull`	Carried modifyDate walk and unconditional mark-as-shipped
Shipments	`pull`	Created and voided walks carried between passes

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Orders

pull: Carried modifyDate walk and unconditional mark-as-shipped

The following example matches configuration standard.

import { shipstation } from "@bijection/connectors/shipstation";

export const orders = shipstation.orders.pull({});

Inferred record types

Resource without an operational record table

Configuration: standard

Case: shipstation/orders/pull/standard. Connection and resource configuration are declared by this exact case. Credential kind: shipstation. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "shipstation",
    "output": {
      "kind": "single",
      "collection": "orders"
    },
    "credential_kind": "shipstation",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://ssapi.shipstation.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: orders

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "all": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "since": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange all",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange since",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "orders": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "all": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "since": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange all",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange since",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“orders”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
budget-shared	{“kind”:“connection”}	Native test: integrations/acquisition/budget_one_bucket_is_spent_by_a_collection_and_by_a_command (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/shipstation/fixtures/identity.json	passed (2026-10-24T21:36:12.340Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: shipped

Case: shipstation/orders/pull/shipped. Connection and resource configuration are declared by this exact case. Credential kind: shipstation. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "shipstation",
    "output": {
      "kind": "single",
      "collection": "orders"
    },
    "credential_kind": "shipstation",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://ssapi.shipstation.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: orders

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "all": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "since": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange all",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange since",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {
    "markShipped": {
      "target": "orders",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    }
  }
}

Commands

Command	Target	Condition	Delivery
`markShipped`	orders	Unconditional	Single dispatch attempt

Commands, occurrences and artifacts

{
  "records": {
    "orders": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "all": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "since": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange all",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange since",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {
          "markShipped": {
            "target": "orders",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          }
        }
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {
    "markShipped": {
      "target": "orders",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    }
  }
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“orders”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
command-response-lost	{“kind”:“command”,“name”:“markShipped”}	Native test: integrations/listeners/calendar_repair_preserves_accepted_responsibility (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
budget-shared	{“kind”:“connection”}	Native test: integrations/acquisition/budget_one_bucket_is_spent_by_a_collection_and_by_a_command (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/shipstation/fixtures/identity.json	passed (2026-10-24T21:36:12.340Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Shipments

pull: Created and voided walks carried between passes

The following example matches configuration standard.

import { shipstation } from "@bijection/connectors/shipstation";
export const shipments = shipstation.shipments.pull();

Inferred record types

Resource without an operational record table

Configuration: standard

Case: shipstation/shipments/pull/standard. Connection and resource configuration are declared by this exact case. Credential kind: shipstation. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "shipstation",
    "output": {
      "kind": "single",
      "collection": "shipments"
    },
    "credential_kind": "shipstation",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://ssapi.shipstation.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: shipments

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "all": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "created": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "voided": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange all",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange created",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.3",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange voided",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2",
          "acquire.3"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "shipments": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "all": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "created": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "voided": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange all",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange created",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.3",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange voided",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2",
                "acquire.3"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“shipments”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
budget-shared	{“kind”:“connection”}	Native test: integrations/acquisition/budget_one_bucket_is_spent_by_a_collection_and_by_a_command (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/shipstation/fixtures/identity.json	passed (2026-10-24T21:36:12.340Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: webhooks

Case: shipstation/shipments/pull/webhooks. Connection and resource configuration are declared by this exact case. Credential kind: shipstation. Keep credential material in the private credential inventory. Inspect the complete configuration contract below for settings and conditional requirements.

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "shipstation",
    "output": {
      "kind": "single",
      "collection": "shipments"
    },
    "credential_kind": "shipstation",
    "connection_fields": [],
    "address": {
      "kind": "fixed",
      "url": "https://ssapi.shipstation.com"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {}
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: shipments

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "all": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "created": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "voided": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange all",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange created",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.3",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange voided",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.4",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "listener changes",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2",
          "acquire.3",
          "acquire.4"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "shipments": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": true,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "all": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "created": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "voided": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange all",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange created",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.3",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange voided",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.4",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "listener changes",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2",
                "acquire.3",
                "acquire.4"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
listener-custody-before-ack	{“kind”:“listener”,“collection”:“shipments”}	Native test: integrations/listeners/webhook_delivery_commits_responsibility_before_acknowledging (shared_engine)	Execution result unavailable
listener-duplicate-delivery	{“kind”:“listener”,“collection”:“shipments”}	No check exercises this packaged ShipStation declaration against ShipStation; it has not run or been qualified.	Execution result unavailable
page-publication-recovery	{“kind”:“collection”,“name”:“shipments”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
budget-shared	{“kind”:“connection”}	Native test: integrations/acquisition/budget_one_bucket_is_spent_by_a_collection_and_by_a_command (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/shipstation/fixtures/identity.json	passed (2026-10-24T21:36:12.340Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. The connection dials https://ssapi.shipstation.com (V1) with a shipstation credential (shipstation.credential): the API key and secret as Basic. The connection’s budget is ShipStation’s 40 requests a minute, and a 429 waits for X-Rate-Limit-Reset. ShipStation serves no account resource, so the connection asserts no account identity. Times are Pacific local text with no offset, in requests and responses. The walks compare and send that text as written and never convert it; the carried overlap is 65 minutes so the repeated autumn hour is read again.

orders.pull: modifyDateStart with sortBy=ModifyDate&sortDir=ASC, 500 a page, ended by the stated pages, carried between passes. orderStatus is kept as stated. Money (orderTotal, amountPaid, taxAmount, shippingAmount) is JSON numbers, kept as the received double’s text and not exact; ShipStation names no currency. Nothing is withdrawn.
shipments.pull: shipments have no modification filter, so a pass walks the shipments created since the last pass, then those voided since it, each sorted by CreateDate and paged by number. Neither set loses members during a walk (creating and voiding happen once), so a change adds a row that is read again rather than skipping one. The version is voidDate, so a void republishes the shipment.

markShipped posts /orders/markasshipped with the target orderId and the given carrier and tracking fields. ShipStation documents no idempotency or precondition, so it is one unconditional attempt and a lost answer stays unknown. V1 webhooks are unsigned and stay unadmitted. With updates: "v2webhooks", a ShipStation API v2 webhook (registered through the v2 API) asks for the resource’s next pass: v2 signs <x-shipengine-timestamp>.<raw body> with RSA PKCS#1 v1.5 and SHA-256 under the key x-shipengine-rsa-sha256-key-id names in https://api.shipengine.com/jwks, which the platform reads without a credential and caches; the timestamp bounds replay to five minutes. A delivery has no identity, so the SHA-256 of its exact body is one. No signed v2 sample is published, so the verifier is tested with the scheme’s own vectors only. Nothing here has run against ShipStation or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Orders

pull: Carried modifyDate walk and unconditional mark-as-shipped

Configuration: standard

Configuration: shipped

Shipments

pull: Created and voided walks carried between passes

Configuration: standard

Configuration: webhooks

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Orders

​pull: Carried modifyDate walk and unconditional mark-as-shipped

​Configuration: standard

​Configuration: shipped

​Shipments

​pull: Created and voided walks carried between passes

​Configuration: standard

​Configuration: webhooks

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Orders

pull: Carried modifyDate walk and unconditional mark-as-shipped

Configuration: standard

Configuration: shipped

Shipments

pull: Created and voided walks carried between passes

Configuration: standard

Configuration: webhooks

Provider guidance

Provider references

Source and evidence