Home » API Documentations » OMS APIs » Replenishment » Replenishment API RESTful v3

Replenishment API RESTful v3

Please note:

It is your responsibility to properly set up all translation features, perform testing, and request support from ShipEdge in a timely manner. It is your responsibility to test and verify the integration between ShipEdge and any 3rd party selling channel. We strongly recommend frequent testing of any integration, especially when changes occur on your selling channel (e.g. SKU renaming, shipping method variations, permissions, and credentials). ShipEdge is not responsible for translation issues, omitted orders, or any other issues related to communication with any 3rd party selling channel. Support for channel automation requires at least 24 hours for investigation before any action can be taken (hourly development charges may apply). The warehouse is not responsible for any omission, duplication or error in your orders coming through this system, and you agree not to get the warehouse involved in integration issues, nor will they make any exception or procedure changes due to the use of this feature.

 

Base

http://<integration>.shipedge.com/API/Rest/v3/Replenishment

Note:

<integration> This will be found in your ShipEdge account. Preferences > API Integration > Web Services Production

 

Get replenishment

Gets the replenishment.

GET /get_reple/<reple_id>/<warehouse>

Parameters

ParameterTypeDescription
X-UIDintYour account ID. This will be found in your ShipEdge account. Preferences > API Integration > AccountID.
X-TIMESTAMPintTimestamp YYYYMMDDHHmmSS
key (*)varcharThis will be found in your ShipEdge account. Preferences > API Integration > key.
X-KEYvarcharX-KEY should be a sha1 hash consisting of “AccountID””Timestamp””Key”.

 

Example header

X-UID: 123
X-TIMESTAMP: 1589293721
X-KEY: b3f2c699daad5cb200babcaf180aa9df01a8b4b5

 

Example request

GET
https://integration.shipedge.com/API/Rest/v3/Replenishment/get_reple/13224/wh1

 

Example response

{
  "success": true,
  "data": {
    "reple_id": 13224,
    "po_num": "123456",
    "status": "intransit",
    "tracking_num": "1212122",
    "supplier_name": "test_sp",
    "comments": "comments",
    "expected_delivery_date": "2019-01-28",
    "pre_sync": "On",
    "items": [{
      "sku": "test",
      "description": "description",
      "qty_request": 2,
      "qty_received": 0,
      "bin": null,
      "lpn": "lpn20",
      "lot": "lot5",
      "expir": "2020-10-10",
      "uom": "uom5"
    }, {
      "sku": "test022",
      "description": "",
      "qty_request": 5,
      "qty_received": 0,
      "bin": null,
      "lpn": "",
      "lot": "",
      "expir": null,
      "uom": ""
    }]
  }
}

 

Add replenishment

  • POST /create_reple

 

Parameters

ParameterTypeDescription
X-UIDintYour account ID. This will be found in your ShipEdge account. Preferences > API Integration > AccountID.
X-TIMESTAMPintTimestamp YYYYMMDDHHmmSS
key (*)varcharThis will be found in your ShipEdge account. Preferences > API Integration > key.
warehouse (*)varcharThis will be found in your ShipEdge account. Preferences > API Integration > Warehouse.
X-KEYvarcharX-KEY should be a sha1 hash consisting of “AccountID””Timestamp””Key”.
supplier_namevarcharThe name of the sender visible in the from field of the shipment’s Shipping Label or Bill of Lading (Optional).
po_num (*)varchar(Required)
tracking_numvarchar(Optional)
commentsvarcharYou can use comments to give some special instructions or reminders to the warehouse team (Optional).
expected_delivery_date (*)DATA(YYYY-MM-DD)Expected date of arrival of products (Required).
pre_syncEnum (On,Off)Updated inventory in Shopping Carts before product physically arriving (Optional).
items (*)array(required)
sku (*)varcharThe SKU’s name is unique by product. The SKU must be in your Shipedge inventory (Required).
qty(*)intQuantity of the product expected. The Qty must be greater than zero (Required).
description(Optional)
lotLot Number
lpnLicence Plate Number
expirDATA(YYYY-MM-DD)Expiration date
uomUnit of Measure

 

Example header

X-UID: 123
X-TIMESTAMP: 1589293721
X-KEY: b3f2c699daad5cb200babcaf180aa9df01a8b4b5

 

Example request

{
  "data": {
    "warehouse": "wh1",
    "supplier_name": "test_sp",
    "po_num": "123456",
    "tracking_num": "1212122",
    "comments": "comments",
    "expected_delivery_date": "2019-01-28",
    "pre_sync": "on",
    "items": [{
      "sku": "test",
      "qty": "2",
      "description": "descripicion",
      "lot": "lot5",
      "lpn": "lpn20",
      "expir": "2020-10-10",
      "uom": "uom5"
    }, {
      "sku": "test022",
      "qty": "5"
    }]
  }
}

Example response

{
  "success": true,
  "reple_id": 12345,
  "data": {
    "data": {
      "warehouse": "wh1",
      "supplier_name": "test_sp",
      "po_num": "123456",
      "tracking_num": "1212122",
      "comments": "comments",
      "expected_delivery_date": "2019-01-28",
      "pre_sync": "on",
      "items": [{
        "sku": "test",
        "qty": "2",
        "description": "descripicion",
        "lot": "lot5",
        "lpn": "lpn20",
        "expir": "2020-10-10",
        "uom": "uom5"
      }, {
        "sku": "test022",
        "qty": "5"
      }]
    }
  }
}

 

Responses:

1011 => "no warehouse provided",
1012 => "invalid warehouse",
1013 => "invalid account_id",
1014 => "not authorization",
1015 => "invalid pre_sync",
1016 => "invalid expected_delivery_date",
1017 => "no expected_delivery_date provided",
1018 => "sku error",
1019 => "invalid key",
1020 => "no reple_id for this po_num",
1021 => "try again later",
1022 => "no po_num provided",
1023 => "no expected_delivery_date provided",
1024 => "no items provided",
1025 => "no sku provided",
1026 => "no qty provided",
1027 => "no description provided",
1028 => "successful",
1029 => "no data provided"
1030 => "reple_id is not registered"

In this Documentation