New Provider: Difference between revisions

From Fulfiller Wiki
Jump to navigation Jump to search
(Created page with " == Provider Table == name - How provider is referred to in code and database. All lowercase. Not too long. display - Display name for provider. explicit_ship - Does provider explicitly specify the shipping carrier and method? combine_ship - Does provider use combined_shipments? cache_assets - Should artwork be cached? Useful for providers that expire artwork quickly. check_mins - How often to check that orders have been received from provider. Zero is don't check. noti...")
 
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Production Workstations ==
See New Provider Wiki page.
== Ship Workstations ==
- Ask the provider these questions:
What is the shipping "from" name and phone number?
What is the shipping return name, phone number, and address?
- Create a new provider-<provider>.json file to configure the from info, return info, and shipping accounts.
== Code ==
- If provider is not explicitly specifying shipping (carrier and service), then create the appropriate PHP source file lib/shipspec_<provider>.inc.php
- If provider has a specific notification API, then implement in lib/notify_<provider>.inc.php
== Reporting ==
- Set up semimonthly volume and detail reports for billing
- Set up daily volume reports (for people who want/allowed to have financials)
- Set up daily received reports (for people who don't need/allowed to have financials)
== Database ==
- Add record to provider table (see below)
- If provider is using our API, add a key to api_key table
- Add csr record to access table




== Provider Table ==
== Provider Table ==
name - How provider is referred to in code and database. All lowercase. Not too long.
name - How provider is referred to in code and database. All lowercase. Not too long.
display - Display name for provider.
display - Display name for provider.
explicit_ship - Does provider explicitly specify the shipping carrier and method?
 
explicit_ship - Does provider explicitly specify the shipping carrier and service?
 
combine_ship - Does provider use combined_shipments?
combine_ship - Does provider use combined_shipments?
cache_assets - Should artwork be cached? Useful for providers that expire artwork quickly.
cache_assets - Should artwork be cached? Useful for providers that expire artwork quickly.
check_mins - How often to check that orders have been received from provider. Zero is don't check.
check_mins - How often to check that orders have been received from provider. Zero is don't check.
notify_status - What status states should be notified to provider (production,pending,shipped,cancel,error)
notify_status - What status states should be notified to provider (production,pending,shipped,cancel,error)

Latest revision as of 12:35, 11 July 2023

Production Workstations[edit]

See New Provider Wiki page.

Ship Workstations[edit]

- Ask the provider these questions:

What is the shipping "from" name and phone number?

What is the shipping return name, phone number, and address?

- Create a new provider-<provider>.json file to configure the from info, return info, and shipping accounts.


Code[edit]

- If provider is not explicitly specifying shipping (carrier and service), then create the appropriate PHP source file lib/shipspec_<provider>.inc.php

- If provider has a specific notification API, then implement in lib/notify_<provider>.inc.php


Reporting[edit]

- Set up semimonthly volume and detail reports for billing

- Set up daily volume reports (for people who want/allowed to have financials)

- Set up daily received reports (for people who don't need/allowed to have financials)


Database[edit]

- Add record to provider table (see below)

- If provider is using our API, add a key to api_key table

- Add csr record to access table


Provider Table[edit]

name - How provider is referred to in code and database. All lowercase. Not too long.

display - Display name for provider.

explicit_ship - Does provider explicitly specify the shipping carrier and service?

combine_ship - Does provider use combined_shipments?

cache_assets - Should artwork be cached? Useful for providers that expire artwork quickly.

check_mins - How often to check that orders have been received from provider. Zero is don't check.

notify_status - What status states should be notified to provider (production,pending,shipped,cancel,error)