4.0.0 • Published 5 years ago

@datafire/walmart_order v4.0.0

Weekly downloads
26
License
MIT
Repository
github
Last release
5 years ago

@datafire/walmart_order

Client library for Orders API

Installation and Usage

npm install --save @datafire/walmart_order
let walmart_order = require('@datafire/walmart_order').create();

.then(data => {
  console.log(data);
});

Description

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

Actions

getAllOrders

You can display a list of all orders with the query parameter filter criteria.

walmart_order.getAllOrders({
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • shipNode string: Ship Node
    • sku string: Retrieves all orders with the specified SKU.
    • customerOrderId string: Retrives the details of the specified customerOrderId.
    • purchaseOrderId string: The purchase order ID associated with the order to retrieve. One customer order can have multiple purchase orders associated with it.
    • status string: The list of orders corresponding to the requested status.
    • createdStartDate string: Limit orders to those created after this date or a timestamp.
    • createdEndDate string: Limit orders to those created before this date or timestamp.
    • fromExpectedShipDate string: Limit orders to those that have order lines with an expected ship date after this date.
    • toExpectedShipDate string: Limit orders to those that have order lines with an expected ship date before this date.
    • limit integer: The number of orders to be returned. Do not set this parameter to over 200 orders.
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

getReleasedOrders

You can display all released orders that have been created and are ready for fulfilment.

walmart_order.getReleasedOrders({
  "createdStartDate": "",
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • shipNode string: Ship Node
    • createdStartDate required string: Limit orders to those created after this date or a timestamp.
    • limit integer: The number of orders to be returned. Do not set this parameter to over 200 orders.
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

getNextCursorReleasedOrders

You can display all released orders that have been created and are ready for fulfilment with nextCursor path parameter.

walmart_order.getNextCursorReleasedOrders({
  "nextCursor": "",
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • nextCursor required string: Used for pagination when there are more than 200 orders to retrieve. The nextCursor value of the returned response includes a link to another GET call to retrieve the next page. Copy the link and paste it in the next call.
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

getOrderByPurchaseOrderId

You can display details of a specific order based on the purchaseOrderId.

walmart_order.getOrderByPurchaseOrderId({
  "purchaseOrderId": "",
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • purchaseOrderId required string: Purchase Order ID
    • shipNode string: Ship Node
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

acknowledgeOrders

You can acknowledge an entire order, including all of its order lines. Walmart business rules require to acknowledge orders within four hour of receipt of the order, except in extenuating circumstances.

walmart_order.acknowledgeOrders({
  "purchaseOrderId": "",
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • purchaseOrderId required string: Purchase Order ID
    • shipNode string: Ship Node
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

cancelOrder

You can cancel one or more order lines. You must include a purchaseOrderLineNumber when cancelling an order. After cancelling your order, update the inventory for the cancelled order and send it in the next inventory feed.

walmart_order.cancelOrder({
  "purchaseOrderId": "",
  "Content-Type": "",
  "Accept": "",
  "Request body": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • purchaseOrderId required string: Purchase Order ID
    • shipNode string: Ship Node
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • Request body required string
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

refundOrder

You can refund one or more order lines that have been shipped. The response to a successful call contains the order with the refunded line item.

walmart_order.refundOrder({
  "purchaseOrderId": "",
  "Content-Type": "",
  "Accept": "",
  "Request body": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • purchaseOrderId required string: Purchase Order ID
    • shipNode string: Ship Node
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • Request body required string
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

shippingOrder

You can change the status of order lines to "Shipped" and trigger the charge to a customer. You must acknowledge your orders before sending a shipping update to avoid underselling. An order line, once marked as shipped, cannot be updated.

walmart_order.shippingOrder({
  "purchaseOrderId": "",
  "Content-Type": "",
  "Accept": "",
  "Request body": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • purchaseOrderId required string: Purchase Order ID
    • shipNode string: Ship Node
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • Request body required string
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

getAllOrdersNext

You can display a list of all orders with nextCursor path parameter pagination criteria.

walmart_order.getAllOrdersNext({
  "nextCursor": "",
  "Content-Type": "",
  "Accept": "",
  "WM_CONSUMER.CHANNEL.TYPE": "",
  "WM_CONSUMER.ID": "",
  "WM_SEC.TIMESTAMP": "",
  "WM_SEC.AUTH_SIGNATURE": "",
  "WM_SVC.NAME": "",
  "WM_QOS.CORRELATION_ID": ""
}, context)

Input

  • input object
    • nextCursor required string: Used for pagination when there are more than 200 orders to retrieve. The nextCursor value of the returned response includes a link to another GET call to retrieve the next page. Copy the link and paste it in the next call.
    • Content-Type required string (values: application/xml, application/json): application/xml,
    • Accept required string (values: application/xml, application/json): application/xml,
    • WM_CONSUMER.CHANNEL.TYPE required string (values: SWAGGER_CHANNEL_TYPE): Channel Type
    • WM_CONSUMER.ID required string: Your Consumer ID
    • WM_SEC.TIMESTAMP required string: Epoch timestamp
    • WM_SEC.AUTH_SIGNATURE required string: Authentication signature
    • WM_SVC.NAME required string: The Service name
    • WM_QOS.CORRELATION_ID required string: A Transaction ID

Output

Output schema unknown

Definitions

This integration has no definitions

datafire
@infinitebrahmanuniverse/nolb-_datafire_w@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_w
4.0.0

5 years ago

3.0.0

7 years ago