22dcb0f674
* Add source-tplcentral
* Add source definition
* Add missing file
* Update catalog
* Update sample config
* Update formatting
* Update invalid config
* Fix primary key identifier
* Update naming
* Rename variable
* Parametrize page size
* Implement Items stream
* Update schemas
* Update response normalization
* Add arrow
* Implement items stream cursor
* Fix types
* Cleanup
* Add customers stream
* Fix items sort
* Add stock_details stream
* Add inventory stream
* Add orders stream
* Refactor streams to a separate file
* Update cursor handling
* Refactor request_params
* Simplify
* Update params generation
* Update response parse
* Refactor stream+slices
* Refactor parse_response
* Cleanup
* New order
* Fix style
* Refactor parse_reponse
* Fix cursor
* Don't fetch next page after the last
* Fix schema errors
* Flatten shared schemas
* Inline refs
* Fix handling None stream_state
* Update schemas
* Implement primary_key and cursor fields
* Fix style
* Fix style
* Fix schemas
* Fix deep_map
* Fix items schema
* Fix cursor formatting
* Update integration tests assets
* Update README.md
* Remove TODO.md
* Update spec.json
* Cleanup
* Add bootstrap.md
* Increase page sizes
* Increase state checkpoint interval
* Add documentation
* Update links to the documentation
* Add build status badge
* Implement test_source.py
* Improve code testability
* Add stream tests
* Implement test_incremental_streams
* Add requests-mock dependency
* Fix formatting
* Update author
* Run ./gradlew format
* Cleanup failed merge artifacts
* Update sample_state.json
* Add stream documentation urls
* Cleanup
* Preserve upstream naming
* Fix primary key
* Fix configured catalog
* Update schemas
* Update catalog.json
* Fix tests
* Add schema source files
* Split configured catalogs
* Cleanup
* Update documentationUrl
* Add new properties
* Run gradlew format
* Remove additionalProperties: false from the schemas
* Revert "Remove additionalProperties: false from the schemas"
This reverts commit d4e8fea2fd.
1.6 KiB
1.6 KiB
3PL Central source is modeled after their API, each stream representing an API resource. Then, four simple transformations are applied for each stream:
- Object keys are transformed from
TitleCasetosnake_case. - HAL
_linkkeys are removed from all objects. - A
_cursorfield of date-time type is added for each incremental stream. The value of this field is a copy of an actual stream-specific and more or less deeply nested cursor field. - An
_idor_{name}_idfield of integer type is added for each stream. The value of this field is a copy of an actual stream-specific and more or less deeply nested ID._idis a primary key of a stream and is used when the actual ID of the resource is located in a nested object._{name}_idis used when a resource itself doesn't have an ID, but the ID of a depending object is used as a part of a combined primary key where{name}is a name of depending object.
All schemas, field names, structure, and comments represent respective C# models described in the [API documentation (https://api.3plcentral.com/Rels/). Unfortunately, the documentation is somewhat outdated, and some endpoints return additional undocumented fields. These fields are added to the schemas to match actual data fields.
The API authentication endpoint requires either user login ID or name or both. API credentials can be obtained using the service UI.
Customer ID and Facility ID are used in URLs, be it path or query part.
API docs: