{"id":20672094,"url":"https://github.com/workarea-commerce/workarea-ship-station","last_synced_at":"2026-04-20T12:04:46.821Z","repository":{"id":56898453,"uuid":"210609377","full_name":"workarea-commerce/workarea-ship-station","owner":"workarea-commerce","description":null,"archived":false,"fork":false,"pushed_at":"2020-01-03T18:04:38.000Z","size":57,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-18T00:03:41.750Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workarea-commerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-24T13:25:47.000Z","updated_at":"2020-01-03T18:04:38.000Z","dependencies_parsed_at":"2022-08-20T17:40:39.977Z","dependency_job_id":null,"html_url":"https://github.com/workarea-commerce/workarea-ship-station","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-ship-station","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-ship-station/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-ship-station/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workarea-commerce%2Fworkarea-ship-station/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workarea-commerce","download_url":"https://codeload.github.com/workarea-commerce/workarea-ship-station/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242891294,"owners_count":20202323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T20:31:54.395Z","updated_at":"2026-04-20T12:04:46.784Z","avatar_url":"https://github.com/workarea-commerce.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Workarea Ship Station\n================================================================================\n\nShipStation plugin for the Workarea platform.\n\nOverview\n--------------------------------------------------------------------------------\n\nShipStation integration for the Workarea Commerce Platform. This plugin handles\nsending orders via the ShipStation API as well as receiving fulfillment updates\nfrom webhooks.\n\nThis integration supports the following features:\n\n  * API integration to send orders to from Workarea to ShipStation\n  * Webhook endpoints to receive fulfillment data from ShipStation\n  * Administration controls for setting and removing on hold status\n  * Configuration options for ship by date\n\nWorkarea admins with access to the orders screen will have the option to set an order on hold until a specified date.\nAn admin can set a specific hold untill date as well as release orders from on hold that have been placed on hold from the Workarea admin.\n\n\nConfiguration\n--------------------------------------------------------------------------------\n\nShipStation API credentials are required to send orders and receive fulfillments.\nYou can get your API credentials by logging into your ShipStation account and going\nto settings, then clicking \"API settings\" under the \"Account\" tab.\n\nGenerate API keys if there are none present and add them to your host apps secrets file:\n\n```\n  ship_station:\n    api_key: YOUR-API-KEY\n    api_secret: YOUR-API-SECRET\n```\n\n**Fulfillment Notification**\n\nWorkarea receives fulfillment notifications via ShipStation webhooks.\n\nDocumentation on setting up ShipStation Webhooks can be found [here](https://help.shipstation.com/hc/en-us/articles/360025856252-ShipStation-Webhooks#UUID-1a4971f4-8fb5-f4a5-c399-f36cff610435_UUID-9336531a-ef72-7c0f-6fbb-598f8f144cf3)\n\nWhen setting up your integration in ShipStation set the following values:\n\n  * Name Description: Can be anything you want, for example \"Workarea Fulfillment notification\"\n  * Select \"On Items Shipped\" from the drop down.\n  * Select \"All Stores\" from the second dropdown.\n  * Send Url: Put \"https://YOURDOMAINHERE/ship_station_webhook\" - Be sure to change replace YOURDOMAINHERE with your actual domain.\n\nWorkarea supports the \"On Items Shipped\" action only.\n\n**Be sure to create a webhook for each domain your Workarea app supports if you have a multisite setup**\n\nYou can add an optional ship by date lead time via a configuration value.\nThis value will be added to the current date and sent to ShipStation when an order is placed. This date will show as the \"Ship By\" date in the orders admin screen in ShipStation.\n\n```ruby\n  config.ship_station.ship_by_date_lead_days = 5\n```\n\n\nGetting Started\n--------------------------------------------------------------------------------\n\nThis gem contains a Rails engine that must be mounted onto a host Rails application.\n\nThen add the gem to your application's Gemfile specifying the source:\n\n    # ...\n    gem 'workarea-ship_station'\n    # ...\n\nUpdate your application's bundle.\n\n    cd path/to/application\n    bundle\n\n\nWorkarea Platform Documentation\n--------------------------------------------------------------------------------\n\nSee [https://developer.workarea.com](https://developer.workarea.com) for Workarea platform documentation.\n\nLicense\n--------------------------------------------------------------------------------\n\nWorkarea Ship Station is released under the [Business Software License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-ship-station","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkarea-commerce%2Fworkarea-ship-station","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkarea-commerce%2Fworkarea-ship-station/lists"}