Offer

Endpoints

Create an Offer

POST/api/RPC.common.Api.Offer.set?token=<TOKEN>

Key Offer.set · Open page

Parameters

49 body parameters inside data[]
FieldTypeDescription
for_dateStringOffer date
sale_typerequiredStringOffer type name
numStringOffer #
traderStringMerchant
pos_coderequiredStringPoint of Offer (POS)
tax_deal_codeStringTax template
currencyStringCurrency
descriptionStringDescription
internal_descriptionStringComment
discountStringDocument discount %
partnerrequiredObjectPartner object.
partner.idStringCustomer ID
partner.is_companyBooleanCustomer is a company
partner.client_typeStringCustomer type
partner.namerequiredStringName
partner.eikStringUIC
partner.egnStringID
partner.dds_numStringVAT Number
partner.emailStringE-mail
partner.phoneStringPhone
partner.contact_nameStringContact
tax_addressrequiredObjectTax_address object.
tax_address.idStringAddress ID
tax_address.phoneStringPhone
tax_address.emailStringE-mail
tax_address.countryrequiredStringCountry
tax_address.districtStringCounty
tax_address.settlementStringCity
tax_address.streetStringStreet
tax_address.nbhStringDistrict
tax_address.addressStringAddress
tax_address.numStringNumber
tax_address.buildingStringBuilding
tax_address.building_entranceStringEntrance
tax_address.building_floorStringFloor
tax_address.building_apartmentStringApartment
tax_address.zipStringPostal code
tax_address.zip_numStringMailbox
rowsrequiredObjectRows object.
rows.skurequiredStringItem ID (SKU)
rows.skurequiredStringService ID (SKU)
rows.bom_identStringBOM identifier
rows.bom_iterStringBOM counter
rows.bom_positionStringBOM position
rows.quantityrequiredStringQuantity
rows.measure_codeStringUnit of measurement ID
rows.pricerequiredStringUnit price
rows.discountStringDiscount %
rows.descriptionStringDescription

Request example

Create Offer Simple:
{
   "data" : [
      {
         "sale_type" : "Main Sales",
         "partner" : {
            "name" : "PPD LTD",
            "phone" : "+35924240730",
            "is_company" : 1,
            "mail" : "b.krastev@prim.io",
            "eik" : 200160722
         },
         "rows" : [
            {
               "sku" : 10293,
               "quantity" : 5,
               "price" : "70.00"
            },
            {
               "price" : "95.00",
               "quantity" : 5,
               "sku" : 10148
            },
            {
               "sku" : 851346,
               "price" : "46.00",
               "quantity" : 3
            },
            {
               "price" : "70.00",
               "quantity" : 3,
               "sku" : 10126
            },
            {
               "sku" : 10194,
               "price" : "69.00",
               "quantity" : 3
            }
         ],
         "pos_code" : 36534576
      }
   ]
}

cURL

Create So Simple:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "sale_type" : "Main Sales",         "partner" : {            "name" : "PPD LTD",            "phone" : "+35924240730",            "is_company" : 1,            "mail" : "b.krastev@prim.io",            "eik" : 200160722         },         "rows" : [            {               "sku" : 10293,               "quantity" : 5,               "price" : "70.00"            },            {               "price" : "95.00",               "quantity" : 5,               "sku" : 10148            },            {               "sku" : 851346,               "price" : "46.00",               "quantity" : 3            },            {               "price" : "70.00",               "quantity" : 3,               "sku" : 10126            },            {               "sku" : 10194,               "price" : "69.00",               "quantity" : 3            }         ],         "pos_code" : 36534576      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Offer.set?token=<TOKEN>"

Change of description

POST/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>

Key Offer.changeDescription · Open page

Parameters

4 body parameters inside data[]
FieldTypeDescription
idStringOffer ID
numrequiredStringOffer #
descriptionrequiredStringDescription
internal_descriptionrequiredStringInternal description

Request example

Change Description By Num:
{
   "data" : [
      {
         "internal_description" : "Lorem Ipsum Internal Description",
         "description" : "Lorem Ipsum Description",
         "num" : "OFF0000026"
      }
   ]
}
Change Description By Id:
{
   "data" : [
      {
         "id" : 1130206756,
         "description" : "Lorem Ipsum Description",
         "internal_description" : "Lorem Ipsum Internal Description"
      }
   ]
}

cURL

Change Description By Num:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "internal_description" : "Lorem Ipsum Internal Description",         "description" : "Lorem Ipsum Description",         "num" : "OFF0000026"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>"
Change Description By Id:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -d '{   "data" : [      {         "id" : 1130206756,         "description" : "Lorem Ipsum Description",         "internal_description" : "Lorem Ipsum Internal Description"      }   ]}' "https://<DOMAIN_NAME>/api/RPC.common.Api.Offer.changeDescription?token=<TOKEN>"

Response example

    HTTP/1.1 200 OK
{
   "result" : [
      {
         "pos_name" : "Magento",
         "for_date" : "2024-01-24",
         "for_date_formated" : "24.01.2024",
         "type_action" : "offer",
         "internal_description" : null,
         "num" : "OFF0000026",
         "id" : 1130206756,
         "updatedon" : "2026-01-01 09:22:28",
         "description" : null,
         "createdon" : "2024-01-24 16:30:23",
         "type" : "offer"
      }
   ]
}