Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Item.New

post/online/RivhitOnlineAPI.svc/Item.New

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

item_namestring required

Item Name.

Length: 1 to 100 Default: No

item_part_numstring

Item Catalog Number (SKU).

Length: 1 to 15 Default: Item details

barcodestring

Item Barcode.

Length: 1 to 15 Default: No

supplier_idinteger nullable

Item Supplier Id.

Range: 0 to 999999999 Default: Rivhit settings

item_group_idinteger nullable

Item Group Identifier.

Range: 0 to 9999999 Default: Rivhit item group settings

storage_idinteger nullable

Storage Id Serial Number (Rivhit system).

~ The stock will decrease from this storage Range: 0 to 999999 Default: Rivhit storage settings

storage_locationstring

Item Storage Location.

Length: 1 to 40 Default: No

cost_nisnumber double

The Item Cost Price in ILS.

~ Send with ILS Currency Range: Decimal limit Default: 0

sale_nisnumber double

The Item Sale Price in ILS.

~ Send with ILS Currency Range: Decimal limit Default: 0

currency_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

Item Currency Type.

Options: (1 = NIS 2 = USD 3 = EURO 4 = GBP 5 = AUD 6 = CAD 7 = CHF 8 = SEK 9 = DKK 10 = NOK) Default: ILS

exchange_ratenumber double

Fixed Currency Exchange Rate to ILS.

Range: Decimal limit Default: Rivhit settings

cost_mtcnumber double

The Item Cost Price in foreign currency (MTC).

~ Send with MTC Currency Range: Decimal limit (can be negative) Default: No

sale_mtcnumber double

The Item Sale Price in foreign currency (MTC).

~ Send with MTC Currency Range: Decimal limit Default: 0

item_name_englishstring

Item Description (Foreign Language).

Length: 1 to 100 Default: No

item_extended_descriptionstring

Item Full Extended Description.

Length: 1 to 500 Default: No

exempt_vatboolean nullable

Indicates if the item is exempt VAT.

Default: Rivhit settings

request_referencestring nullable

The Item creation Request Reference.

~ Use for future search with method - Status.LastRequest ~ Should be unique value Length: 2GB Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "item_name": "פריט בדיקה",
  "item_part_num": "abc123",
  "barcode": "123456",
  "supplier_id": 1,
  "item_group_id": 1,
  "storage_id": 1,
  "storage_location": "Tel Aviv No 7",
  "cost_nis": 10,
  "sale_nis": 10,
  "currency_id": 1,
  "exchange_rate": 3.8,
  "cost_mtc": 10,
  "sale_mtc": 10,
  "item_name_english": "item test",
  "item_extended_description": "תיאור פריט רחב כולל מאפיינים ",
  "exempt_vat": true,
  "request_reference": "abcdefg-&123456789"
}

Response

Success - Item Created

error_codeinteger

The Response Error/Status Number (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.