npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@commercetools/orders-update

v3.1.0

Published

Library that helps with updating orders into the commercetools platform.

Downloads

28

Readme

commercetools logo

Orders Update

Travis Build Status Codecov Coverage Status David Dependencies Status David devDependencies Status

A library that helps with updating orders into the commercetools platform.

Supported order fields

  • customLineItems
  • lineItems
  • syncInfo
  • returnInfo
  • shippingInfo.deliveries

Usage

CLI

You can use the orders update from the command line using sphere-node-cli. In order for the CLI to update orders, the file to update from must be JSON and follow the this structure:

{
  "orders": [
    <order>,
    <order>,
    ...
  ]
}

To update lineItems/customLineItems status the order object have to follow this format

{
  orderNumber: 1234567,
  lineItems: [{
    state: [{
      fromState: 'statekey',
      toState: 'statekey',
      quantity: 20, // The number of quantity you want to migrate from the a state to another.
      _fromStateQty: 100 // The quantity in the 'fromState' before the update. More information about why this is necessary [here](https://github.com/commercetools/orders-update/issues/11)
    }]
  }]
}

Then you can use this file using the cli:

sphere-node-cli -t order -p my-project-key -f ./orders.json

When updating returnInfo, all items are compared against existing return info items. If there is a matching returnInfo item (matched by keys returnTrackingId and returnDate) script goes through returnItems and sets new shipmentState or paymentState if they differ from old values. If returnInfo item is not found it is inserted as a new item.

Direct usage

If you want more control, you can also use this library directly in JavaScript. To do this you first need to install it:

npm install @commercetools/orders-update --save

Then you can use it to update an order like so:

const fs = require('fs');
const OrdersUpdate = require('orders-update');

const ordersUpdate = new OrdersUpdate({
  config: {
    project_key: '',
    client_id: '',
    client_secret: '',
  },
});

const orderData = JSON.parse(fs.readFileSync('order.json'));

ordersUpdate.processOrder(orderData)
  .then(() => {
    // look at the summary
    console.info(ordersUpdate.summary);

    // {
    //   errors: [...],
    //   inserted: [...],
    //   successfulImports: 1
    // }
  })
  .catch(console.error);

Configuration

OrdersUpdate accepts one object as an argument:

  • API client config (required)
  • Logger takes object with four functions (optional)
    • error
    • warn
    • info
    • verbose

Contributing

See contributing.md for info on contributing.