List Waves

Retrieves List of waves from the database. The data returned from this API will be paged Paging supported.

get

Authorizations

AuthorizationstringRequired

Query parameters

idnumberOptional

A comma-separated list of wave ids.

wave_numberstringOptional

A comma-separated list of wave numbers.

since_idstringOptional

Restrict results to after the specified ID.

storestringOptional

A comma-separated list of Sale Store(s).

show_open_onlystringOptional

Show waves that can only be processed. By default this is true.

lock_flagstringOptional

Show waves according to flag value. By default this is false (showing unlocked waves).

created_at_minstringOptional

Show waves created at or after date (format: 2014-04-25T16:15:47-04:00).

created_at_maxstringOptional

Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).

statusstringOptional

A comma-separated list of statuses.

customerstringOptional

A comma-separated list of customers.

order_numberstringOptional

A comma-separated list of sales order numbers.

max_idnumberOptional

Restrict results to upto the specified ID.

pagenumberRequired

page number of the query result set to return. Default = 1.

updated_at_minstringOptional

Filter records updated on or after this date.

updated_at_maxstringOptional

Filter records updated on or before this date.

enable_pagingstringOptional

When true, returns paginated results using page and page size parameters.

Default: false

exclude_processedbooleanOptional

When true, excludes records already marked as processed.

Default: false

ref_nostringOptional

Reference number used to find matching documents or transactions.

thirdpartyref_nostringOptional

Third-party reference number supplied by the external system.

Responses

200

OK

application/json

IsForwardRequestbooleanOptional

MessagestringOptional

MessageTitlestring · nullableOptional

PagenumberOptional

ResultbooleanOptional

TotalPagesnumberOptional

get/api/xerp/wave/getwave

GET /api/xerp/wave/getwave?page=1 HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Accept: */*

200

OK

{
  "Data": {
    "OrderData": [
      {
        "BillToAddr": "1312 Seymour Cir",
        "BillToAddr2": "",
        "BillToCity": "Lincoln",
        "BillToCompanyName": "",
        "BillToCountry": "USA",
        "BillToCountryISO2": "US",
        "BillToEmail": "",
        "BillToFirstName": "",
        "BillToLastName": "",
        "BillToName": "",
        "BillToPhoneNumber": "",
        "BillToState": "CA",
        "BillToStateAbbr": "CA",
        "BillToZpCode": "95648",
        "CarrierName": "UPS",
        "CurrencyCode": "USD",
        "CustomFieldH1": "",
        "CustomFieldH10": "",
        "CustomFieldH11": "",
        "CustomFieldH12": "",
        "CustomFieldH13": "",
        "CustomFieldH14": "",
        "CustomFieldH15": "",
        "CustomFieldH16": "",
        "CustomFieldH17": "",
        "CustomFieldH18": "",
        "CustomFieldH19": "",
        "CustomFieldH2": "",
        "CustomFieldH20": "",
        "CustomFieldH21": "",
        "CustomFieldH22": "",
        "CustomFieldH23": "",
        "CustomFieldH24": "",
        "CustomFieldH25": "",
        "CustomFieldH26": "",
        "CustomFieldH27": "",
        "CustomFieldH28": "",
        "CustomFieldH29": "",
        "CustomFieldH3": "",
        "CustomFieldH30": "",
        "CustomFieldH4": "",
        "CustomFieldH5": "",
        "CustomFieldH6": "",
        "CustomFieldH7": "",
        "CustomFieldH8": "",
        "CustomFieldH9": "",
        "CustomerEmailMain": "",
        "CustomerFullName": "Customer 1",
        "CustomerMainPhone": "",
        "CustomerPO": "123456",
        "Id": 23897,
        "Memo": "This is a memo",
        "OrderClassCode": "ON",
        "OrderClassName": "Online",
        "OrderDate": "10/03/2018",
        "OrderNumber": "MAIN-S003607",
        "OrderTypeCode": null,
        "OrderTypeName": null,
        "PaymentTermsName": "COD",
        "RefNo": "RefNo203892-1",
        "RiskAnalysis": "",
        "SaleStoreId": 10002,
        "SaleStoreName": "Main Warehouse",
        "ShipMethodName": "Delivery (Third Party)",
        "ShipServiceCode": "UPSG",
        "ShipServiceName": "UPS Ground",
        "ShipStoreName": "Main Warehouse",
        "ShipToAddr": "1312 Seymour Cir",
        "ShipToAddr2": "",
        "ShipToCity": "Lincoln",
        "ShipToCompanyName": "",
        "ShipToCountry": "USA",
        "ShipToCountryISO2": "US",
        "ShipToEmail": "",
        "ShipToFirstName": "",
        "ShipToLastName": "",
        "ShipToName": " ",
        "ShipToPhoneNumber": "",
        "ShipToState": "CA",
        "ShipToStateAbbr": "CA",
        "ShipToZpCode": "95648",
        "ShippingAccountNumber": "",
        "ShippingAmount": 107.25,
        "ShippingCost": 100,
        "ShippingNotes": "This is Shipping Notes",
        "ShippingTermsName": "Prepaid & Billed",
        "StoreId": 10002,
        "Tags": "TagX,TagY",
        "TotalAmount": 384.5,
        "TotalQty": 1,
        "TotalTaxAmount": 35.13,
        "TotalWaveCount": 0,
        "TransferFromStoreId": null,
        "TransferFromStoreName": null,
        "TransferToStoreId": null,
        "TransferToStoreName": "",
        "TypeName": "Sale"
      }
    ],
    "WaveData": [
      {
        "PreviewFlag": false,
        "WaveDetailAllocationArr": [
          {
            "BatchNumber": null,
            "CreateSource": null,
            "DestinationLocationBrcd": null,
            "DestinationLocationId": 0,
            "DestinationLocationName": null,
            "Id": 36205,
            "ItemId": 30111,
            "ItemNumber": "BC",
            "ItemUpc": "",
            "LotNumber": null,
            "LpnId": null,
            "LpnNumber": null,
            "MatchedFlag": false,
            "MfgDate": null,
            "MoId": 0,
            "MoLineId": 0,
            "ModifyDttm": null,
            "ModifySource": null,
            "Note": null,
            "OrderNumber": "MAIN-S003607",
            "PickLocationBrcd": null,
            "PickLocationClassId": 20,
            "PickLocationId": 1,
            "PickLocationName": "MAIN WAREHOUSE - LOCATION-3PL",
            "PickSeq": null,
            "PriorityNumber": null,
            "QtyAllocated": 1,
            "QtyDecimalFlag": false,
            "QtyPicked": 0,
            "SoId": 23897,
            "SoLineId": 40668,
            "StatusId": 330,
            "StatusName": null,
            "StoreId": 10002,
            "WaveDetailId": 42170,
            "WaveId": 4983
          }
        ],
        "WaveDetailArr": [
          {
            "BillToAddrName": null,
            "CarrierId": 1321,
            "CloseFlag": false,
            "ConsolidationLocationId": null,
            "CreateDate": "03/22/2020",
            "CreateDttm": "03/22/2020 10:21:50 PM",
            "CreateSource": "kunalx",
            "CustomerName": "Customer 1",
            "Freight": 100,
            "Id": 42170,
            "IsCustomerOnHold": false,
            "ItemDescription": "Battery Connector",
            "ItemId": 30111,
            "ItemNumber": "BC",
            "ItemTypeId": 10,
            "ItemTypeName": "Inventory",
            "ItemUpc": "",
            "KitItemShort": false,
            "MasterKitKey": null,
            "MatchedFlag": false,
            "MoId": null,
            "MoLineId": null,
            "ModifyDttm": "03/22/2020 10:21:50 PM",
            "ModifySource": "kunalx",
            "Note": "",
            "OrderNumber": "MAIN-S003607",
            "QtyAllocated": 1,
            "QtyDecimalFlag": false,
            "QtyPicked": 0,
            "QtyToPick": 1,
            "RefNo": "RefNo203892-1",
            "SellUomId": 4,
            "ShipFlag": false,
            "ShipMethodId": 30,
            "ShipMethodName": "Delivery (Third Party)",
            "ShipServiceId": 58,
            "ShipToAddrName": null,
            "SoId": 23897,
            "SoLineId": 40668,
            "SoNumber": null,
            "StatusId": 330,
            "StatusName": "Allocated",
            "StoreId": 10002,
            "StoreName": "Main Warehouse",
            "ThirdPartySource": "Shopify-Account1",
            "UnitPrice": 384.5,
            "WaveDefaultLocationId": null,
            "WaveDetailAllocationArr": null,
            "WaveId": 4983,
            "WaveNumber": "MAIN-W002032",
            "WaveStatusId": 0,
            "WaveStatusName": null,
            "WaveTypeId": 10,
            "WaveTypeName": "Sales"
          }
        ],
        "WaveHeaderData": {
          "CloseWave": false,
          "CloseWaveByLinesOnly": false,
          "CreateDttm": "03/22/2020 10:21:50 PM",
          "CreateSource": null,
          "Id": 4983,
          "LockFlag": false,
          "LockToggleFlag": false,
          "ModifyDttm": null,
          "ModifySource": null,
          "Note": "",
          "OrderWaveCount": 0,
          "PlannedShipDate": "10/20/2019",
          "PriorityId": null,
          "PriorityName": "",
          "StatusId": 330,
          "StatusName": "Allocated",
          "StoreId": 10002,
          "StoreName": "Main Warehouse",
          "TypeId": 10,
          "TypeName": "Sales",
          "UploadFlag": false,
          "WaveNumber": "MAIN-W002032"
        }
      }
    ]
  },
  "IsForwardRequest": false,
  "Message": "Wave data loaded successfully",
  "MessageTitle": null,
  "Page": 1,
  "Result": true,
  "TotalPages": 1
}