Skip to content

Mashey/tap-marketman

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarketMan Tap

This is a Singer tap that reads data from the MarketMan API and produces JSON-formatted data following the Singer spec.

How to use it

tap-marketman works together with any other Singer Target to move data from the MarketMan API to any target destination.

Install

First, make sure Python 3 is installed on your system or follow these installation instructions for Mac or Ubuntu.

This project is set up using Python Poetry. Once cloned and within the project directory, install dependencies with:

poetry install

Configuration

Requirements to get started are API Credentials in the form of an APIKey and APIPassword.

The first portion of the tap is to pull all the GUIDs that are associated with the credentials. This will allow the tap to iterate over these ids and pull data associate with the configured endpoints.

Streams

All Streams have the field of GUID (all caps). This is the identifier for which GUID the record is associated with in the pull.

Full Table Streams

These Streams pull all the data each time they are run based on the endpoint. Different targets can handle duplicate data differently.

Inventory Items

  • Primary key fields: ID
  • Replication strategy: FULL_TABLE
  • Transformations: none
  • Additional Keys: GUID

Menu Items

  • Primary key fields: ID
  • Replication strategy: FULL_TABLE
  • Transformations: none
  • Additional Keys: GUID

Preps

  • Primary key fields: ID
  • Replication strategy: FULL_TABLE
  • Transformations: none
  • Additional Keys: GUID

Incremental Streams

These Streams pull data from between two timestamps. Inital timestamps should be based on earliest needed times. Each run resets this timestamp to the current run data and time. Different targets can handle duplicate data differently.

Inventory Counts

  • Primary key fields: ID
  • Replication strategy: INCREMENTAL
  • Replication based on: Start Date through End Date (Bookmarked)
  • Transformations: none
  • Additional Keys: GUID

Waste Events

  • Primary key fields: ID
  • Replication strategy: INCREMENTAL
  • Replication based on: Start Date through End Date (Bookmarked)
  • Transformations: none
  • Additional Keys: GUID

Orders by Sent Date

  • Primary key fields: OrderNumber
  • Replication strategy: INCREMENTAL
  • Replication based on: Start Date through End Date (Bookmarked)
  • Transformations: none
  • Additional Keys: GUID

Transfers

  • Primary key fields: ID
  • Replication strategy: INCREMENTAL
  • Replication based on: Start Date through End Date (Bookmarked)
  • Transformations: none
  • Additional Keys: GUID

About

A Singer Tap for the MarketMan API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages