@aglyn/aglyn 1.0.0-beta.255 → 1.0.0-beta.256

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4531,14 +4531,14 @@ export const DOCS_SECTION_INDEX = [
4531
4531
  title: 'Fulfillment networks (ShipBob, ShipMonk and Amazon MCF)',
4532
4532
  heading: 'Connect a network',
4533
4533
  anchor: '#connect-a-network',
4534
- text: '1. Open Products → Shipping & delivery and find the Fulfillment networks card.\n2. Next to ShipBob or Amazon Multi-Channel Fulfillment (when the card offers them), select Connect.\n3. Sign in to that account and allow Aglyn access. You come back to the store settings with the network connected.\nYou need to be an admin of the site to connect, change or disconnect a network. Aglyn never sees your ShipBob or Amazon password; it keeps only the access the network grants, encrypted.\nShipMonk: connect with your API key\nShipMonk connects with an API key from your own ShipMonk account instead of a sign-in:\n1. In ShipMonk, open Account Settings, then Integration API Keys. If you have no API store yet, ShipMonk sets one up for you when you ask under Stores.\n2. Create an API key for your API store, and note the store\'s id shown beside it.\n3. On Products → Shipping & delivery, select Connect ShipMonk, paste the key, enter the store id and select Connect.\nAglyn checks the key with ShipMonk before keeping it, keeps it encrypted, and never shows it again. To use a new key, revoke the old one in ShipMonk: the card asks you to Connect again, and you paste the new one.\nAfter you connect, the card shows a webhook address and a signing secret, once. Give both to ShipMonk (its webhook settings under Integrations, or ShipMonk support) so it tells Aglyn the moment an order ships. Aglyn checks every webhook\'s signature and ignores any that does not match. Without webhooks, Aglyn still reads each order back from ShipMonk every 15 minutes. New webhook secret makes a new secret and ends the old one at once.\n- ShipBob creates a channel for Aglyn in your ShipBob account. Orders appear under it.\n- Amazon asks you to choose the marketplace whose FBA inventory ships your orders, if your seller account se'
4534
+ text: '1. Open Products → Shipping & delivery and find the Fulfillment networks card.\n2. Next to ShipBob or Amazon Multi-Channel Fulfillment (when the card offers them), select Connect.\n3. Sign in to that account and allow Aglyn access. You come back to the store settings with the network connected.\nYou need to be an admin of the site to connect, change or disconnect a network. Aglyn never sees your ShipBob or Amazon password; it keeps only the access the network grants, encrypted.\nShipMonk: connect with your API key\nShipMonk connects with an API key from your own ShipMonk account instead of a sign-in:\n1. In ShipMonk, open Account Settings, then Integration API Keys. If you have no API store yet, ShipMonk sets one up for you when you ask under Stores.\n2. Create an API key for your API store, and note the store\'s id shown beside it.\n3. On Products → Shipping & delivery, select Connect ShipMonk, paste the key, enter the store id and select Connect.\nAglyn checks the key with ShipMonk before keeping it, keeps it encrypted, and never shows it again. To use a new key, revoke the old one in ShipMonk: the card asks you to Connect again, and you paste the new one.\nAfter you connect, the card shows a webhook address and a signing secret, once. Give both to ShipMonk (its webhook settings under Integrations, or ShipMonk support) so it tells Aglyn the moment an order ships. Aglyn checks every webhook\'s signature and ignores any that does not match. Without webhooks, Aglyn still reads each order back from ShipMonk every 15 minutes. New webhook secret makes a new secret and ends the old one at once.\nFlexport: connect with your API token\nRolling out Flexport appears on the Fulfillment networks card only once it is available on the platform you use. Until then, the card has no Flexport section'
4535
4535
  },
4536
4536
  {
4537
4537
  path: '/commerce-and-bookings/commerce/fulfillment-networks',
4538
4538
  title: 'Fulfillment networks (ShipBob, ShipMonk and Amazon MCF)',
4539
4539
  heading: 'Settings',
4540
4540
  anchor: '#settings',
4541
- text: '| Setting | What it does |\n| Sending | Automatic sends every paid order with a shipping address. Manual sends an order only when you select Send to it on the order. |\n| Ship option (ShipBob) | The ShipBob ship option orders ask for, as named in your ShipBob account. Standard unless you change it. |\n| Shipping service (ShipMonk) | The shipping service orders ask for. It must match a shipping mapping in your ShipMonk account. Standard unless you change it. |\n| Shipping speed (Amazon) | Standard, Expedited or Priority. Amazon bills you for the speed you choose. |\n| Marketplace (Amazon) | The marketplace whose inventory ships. |\n| Keep stock counts in step | Sets your store\'s count of each SKU to what the network can ship. Off until you turn it on. |\nPause stops new orders going to the network. Orders it already has keep coming back as they ship. An order paid while a network is paused is not sent later; send it from the order if you want the network to ship it.'
4541
+ text: '| Setting | What it does |\n| Sending | Automatic sends every paid order with a shipping address. Manual sends an order only when you select Send to it on the order. |\n| Ship option (ShipBob) | The ShipBob ship option orders ask for, as named in your ShipBob account. Standard unless you change it. |\n| Shipping service (ShipMonk) | The shipping service orders ask for. It must match a shipping mapping in your ShipMonk account. Standard unless you change it. |\n| Ship method (Flexport) | The ship method orders ask for, such as Standard or UPS Ground. Flexport sets each order\'s delivery speed from it. Standard unless you change it. |\n| Shipping speed (Amazon) | Standard, Expedited or Priority. Amazon bills you for the speed you choose. |\n| Marketplace (Amazon) | The marketplace whose inventory ships. |\n| Keep stock counts in step | Sets your store\'s count of each SKU to what the network can ship. Off until you turn it on. |\nPause stops new orders going to the network. Orders it already has keep coming back as they ship. An order paid while a network is paused is not sent later; send it from the order if you want the network to ship it.'
4542
4542
  },
4543
4543
  {
4544
4544
  path: '/commerce-and-bookings/commerce/fulfillment-networks',
@@ -4559,7 +4559,7 @@ export const DOCS_SECTION_INDEX = [
4559
4559
  title: 'Fulfillment networks (ShipBob, ShipMonk and Amazon MCF)',
4560
4560
  heading: 'Shipments and tracking',
4561
4561
  anchor: '#shipments-and-tracking',
4562
- text: 'Each parcel the network ships becomes a shipment on the order, with its carrier and tracking number. When every item has shipped, the order is Fulfilled.\n- Amazon reports where each parcel is. Aglyn follows it until it is delivered or returned, for up to 30 days, and the order moves to Delivered when every parcel has arrived.\n- ShipBob tells Aglyn when a parcel is delivered or has a delivery problem, and the order shows it.\n- ShipMonk reports each package of an order, including the parts of an order it split, and where the order is. Aglyn follows it until it is delivered, for up to 30 days. If ShipMonk holds an order, for example on backorder or because it needs an address fixed, the order says so.'
4562
+ text: 'Each parcel the network ships becomes a shipment on the order, with its carrier and tracking number. When every item has shipped, the order is Fulfilled.\n- Amazon reports where each parcel is. Aglyn follows it until it is delivered or returned, for up to 30 days, and the order moves to Delivered when every parcel has arrived.\n- ShipBob tells Aglyn when a parcel is delivered or has a delivery problem, and the order shows it.\n- ShipMonk reports each package of an order, including the parts of an order it split, and where the order is. Aglyn follows it until it is delivered, for up to 30 days. If ShipMonk holds an order, for example on backorder or because it needs an address fixed, the order says so.\n- Flexport reports each package of an order and tells Aglyn when it is delivered. If Flexport holds an order or cannot fulfill it, for example because it cannot ship to the address, the order shows Flexport\'s reason.'
4563
4563
  },
4564
4564
  {
4565
4565
  path: '/commerce-and-bookings/commerce/fulfillment-networks',
@@ -4575,6 +4575,48 @@ export const DOCS_SECTION_INDEX = [
4575
4575
  anchor: '#activity',
4576
4576
  text: 'Each connected network has an activity list on the card: orders sent, parcels shipped, cancellations, stock syncs and errors, newest first.\nIf a network stops accepting the connection, for example after you remove Aglyn\'s access there, the card asks you to Connect again. Orders paid in the meantime wait and are sent once you reconnect.\nDisconnect stops sending orders and removes the stored access. Orders the network already holds are left with it: check them in the network\'s own account, and ship anything it has not shipped another way.'
4577
4577
  },
4578
+ {
4579
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4580
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4581
+ heading: '',
4582
+ anchor: '',
4583
+ text: 'Inventory and ERP sync: Cin7 Core, inFlow, Brightpearl and Ordoro\nRolling out Inventory sync appears in your console only once it is available on the platform you use. Until then, no Inventory and ERP card appears on Products → Integrations, and your stock is counted the way it is today.\nIf you run your stock in Cin7 Core (formerly DEAR Inventory), inFlow Inventory, Brightpearl or Ordoro, connect that account to your store and Aglyn keeps the two in step:\n- Stock counts follow whichever side you say is right: the system\'s count of each SKU becomes your store\'s, or your store\'s count is written into the system.\n- Products can come into your store from the system, or your store\'s products can be made in the system.\n- Paid orders go to the system as sales orders, so it can pick, pack and account for them.\nA store syncs with one system at a time.'
4584
+ },
4585
+ {
4586
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4587
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4588
+ heading: 'Connect a system',
4589
+ anchor: '#connect-a-system',
4590
+ text: 'You need to be an admin of the site to connect, change or disconnect a system.\n1. Open Products → Integrations and find the Inventory and ERP card.\n2. Connect the system you use:\n- Cin7 Core: in Cin7 Core, go to Integrations → API and add an API application. Paste its Account ID and Application key into the card and select Connect Cin7 Core.\n- inFlow: in inFlow, go to Options → Integrations and generate an API key (your inFlow plan needs the API access add-on). Paste the Company ID and API key and select Connect inFlow Inventory.\n- Brightpearl: enter your Brightpearl account code (the name in your Brightpearl address) and select Connect Brightpearl. Sign in to Brightpearl and allow access; you come back to Integrations with it connected.\n- Ordoro: in Ordoro, go to Account Settings → API Keys, add an API key and select Edit beside it. Paste its Client ID and Client secret and select Connect Ordoro. Ordoro\'s API is available on its Premium plan and above.\nKeys are checked with the system before they are saved, and stored encrypted. They are never shown again. Aglyn never sees your Brightpearl password.\nWhen you connect, nothing is synced until you choose what to sync below.'
4591
+ },
4592
+ {
4593
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4594
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4595
+ heading: 'Stock counts',
4596
+ anchor: '#stock-counts',
4597
+ text: 'Which counts are right decides the direction:\n| Choice | What happens |\n| The system (Cin7 Core, inFlow, Brightpearl or Ordoro) | About every 30 minutes, the system\'s count of each SKU that can be sold now (on hand, less what the system has set aside for its own orders) becomes your store\'s count. Each change appears in your products\' Stock movements, counted by the system. |\n| The store | About every 30 minutes, the system\'s count of each SKU is adjusted to match your store\'s. Each run is one stock adjustment in the system; in Ordoro, each SKU\'s count is adjusted on its own. |\n| Don\'t sync counts | Counts are left alone on both sides. |\nChoose the location (in Brightpearl and Ordoro, the warehouse) whose counts are synced. To push your store\'s counts into the system you must choose one location; reading counts from the system can also add up all locations.\n- Counts are matched by SKU. A SKU only one side has is left alone, and the card says how many there were.\n- An order that is paid but not yet sent to the system is allowed for, so a unit is never sold twice while the order is on its way.\n- A product that does not track stock, or that counts stock per location, is left alone when counts come from the system.\n- Only counts that changed are written each run, and every count is written again once a day, so a count edited by hand on one side comes back in step.'
4598
+ },
4599
+ {
4600
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4601
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4602
+ heading: 'Products',
4603
+ anchor: '#products',
4604
+ text: '| Choice | What happens |\n| Import from the system | About every 6 hours, products added or changed in the system are added to your store as drafts, with their SKU and price in your store\'s currency, and kept in step after that. Review a draft and publish it when it is ready. A product you delete in the store is not added again. |\n| Make store products in the system (Cin7 Core, inFlow and Ordoro) | Store products with a SKU the system does not have are made there, with their name, description and barcode, and in Cin7 Core their price and weight. In inFlow, set the price in inFlow\'s pricing scheme. In Ordoro, products are made with their name, price and barcode (as the UPC); add the description and weight in Ordoro. |\n| Match by SKU only | Nothing is made on either side. |\nBrightpearl products are made in Brightpearl, since each needs a brand, a product type and channel choices, so Brightpearl offers Import and Match by SKU only.\nEach run makes or updates up to 50 products and carries on with the rest on the next run. A product the system has no price for in your store\'s currency is not imported, and the activity says so.'
4605
+ },
4606
+ {
4607
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4608
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4609
+ heading: 'Orders',
4610
+ anchor: '#orders',
4611
+ text: 'Turn on Send paid orders and choose who orders are recorded under:\n- Cin7 Core and inFlow: the name of a customer that already exists in the system, such as "Web Sales".\n- Brightpearl: the ID of an existing Brightpearl contact.\n- Ordoro: the name of an Ordoro sales channel that already exists, such as "Web Sales". Orders are recorded under that channel, and Ordoro puts the channel\'s number in front of each order number.\nIn Cin7 Core you can also name the tax rule order lines carry; leave it empty to use the customer\'s own.\nEach paid order is sent within about 15 minutes with its items, buyer, shipping address, shipping, discount, tax and total. It carries a reference such as AG1042-3fa9c2d1 (your order number and a short code), which you can search for in the system. An order is never recorded twice: before sending, Aglyn looks for its reference in the system.\n- Items are matched by SKU. An item with no SKU is left off and the order says so. If the system has no product for a SKU, the order is not sent; add the product in the system, then select Send again.\n- If the system cannot be reached, the order is retried several times over a few hours. If it still cannot be sent, or the system refuses it, it appears under Orders not sent on the card, with the reason and Send again.\n- On the order, the system\'s section shows whether it was sent, its number in the system and its reference.\nCanceling and refunds\nWhen you cancel an order, or refund it in full:\n- Cin7 Core voids the sale, inFlow cancels the sales order, and Ordoro cancels the order. If the system will not, for example because the order has shipped, the order tells you to check it there.\n- Brightpearl: cancel the order in Brightpearl. The order reminds you, with its number there.\nAn order canceled before it was sent i'
4612
+ },
4613
+ {
4614
+ path: '/commerce-and-bookings/commerce/inventory-and-erp-sync',
4615
+ title: 'Inventory and ERP sync (Cin7 Core, inFlow, Brightpearl, Ordoro)',
4616
+ heading: 'Activity',
4617
+ anchor: '#activity',
4618
+ text: 'The card lists what happened, newest first: orders sent, stock and product syncs, cancellations and errors. Sync now syncs stock and products and sends any waiting orders straight away.\nEach system limits how fast it can be called. When it asks Aglyn to slow down, everything for that store waits until the system says to come back, and then carries on where it stopped.\nIf the system stops accepting the keys or the access, the card asks you to Connect again. Orders paid in the meantime wait and are sent once you reconnect.\nPause stops all syncing until you resume. Disconnect stops syncing and deletes the stored keys and activity. Orders not yet sent stay unsent. What the system already has stays there, and so do your store\'s products and counts.'
4619
+ },
4578
4620
  {
4579
4621
  path: '/commerce-and-bookings/commerce/order-notifications',
4580
4622
  title: 'Order emails & status page',