Skip to main content

ShipMonk source

Introduction​

The ShipMonk source connector lets you connect to the ShipMonk API.

This connector is currently in development:

  • Connection (credential validation) is implemented.
  • Catalog discovery currently returns an empty catalog.
  • Extraction/sync is not yet implemented.

Setup​

Prerequisites​

  • A ShipMonk account with API access.
  • A ShipMonk API key.

Get your ShipMonk API key​

Generate or retrieve an API key in ShipMonk, then copy it for use in the connector configuration.

Authentication​

ShipMonk authentication uses an API key sent in the Api-Key request header.

During credential validation, the connector makes a request to:

  • GET https://api.shipmonk.com/v1/products?page=1&pageSize=1

If the request fails, the connector reports a credential validation error.

Configuration​

FieldTypeRequiredDescription
api_keystring✅Your ShipMonk API key. Stored securely and used as the Api-Key header for API requests.

Streams​

No streams are currently exposed.

Limitations​

  • No extraction yet: Running a sync will fail because extraction is not implemented.
  • No catalog yet: The connector does not currently return any streams during catalog discovery.

Troubleshooting​

  • Credential validation failed: Confirm the API key is correct and has access to the ShipMonk API. If your network restricts outbound traffic, ensure https://api.shipmonk.com is reachable.