Set product location prices

POST

/merchants/{merchantCode}/productLocationPrices

const url = 'https://catalog.shopgate.io/v1/merchants/example/productLocationPrices';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"productLocationPrices":[{"productCode":"someCode","locationCode":"someCode","properties":"example","externalUpdateDate":"2018-12-15T00:00:23.114Z","cost":2.55,"price":3.5,"unit":"kg","salePrice":3,"msrp":4.5,"minPrice":3,"maxPrice":7.5,"volumePricing":[{"minQty":1,"maxQty":2,"price":6.4,"salePrice":5,"unit":"kg","priceType":"fixed"}],"mapPricing":[{"startDate":"2018-12-12T14:27:23.114Z","endDate":"2018-12-15T00:00:23.114Z","price":10.1}],"currencyCode":"AED"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://catalog.shopgate.io/v1/merchants/example/productLocationPrices \
  --header 'Content-Type: application/json' \
  --data '{ "productLocationPrices": [ { "productCode": "someCode", "locationCode": "someCode", "properties": "example", "externalUpdateDate": "2018-12-15T00:00:23.114Z", "cost": 2.55, "price": 3.5, "unit": "kg", "salePrice": 3, "msrp": 4.5, "minPrice": 3, "maxPrice": 7.5, "volumePricing": [ { "minQty": 1, "maxQty": 2, "price": 6.4, "salePrice": 5, "unit": "kg", "priceType": "fixed" } ], "mapPricing": [ { "startDate": "2018-12-12T14:27:23.114Z", "endDate": "2018-12-15T00:00:23.114Z", "price": 10.1 } ], "currencyCode": "AED" } ] }'

Parameters

Path Parameters

merchantCode

required

string

<= 255 characters

Query Parameters

catalogCode

string

<= 255 characters

Request Body

application/json

object

productLocationPrices

required

Array

<= 100 items

object

productCode

required

Human readable code of the entity

string

>= 1 characters <= 255 characters

Example

someCode

locationCode

required

Human readable code of the entity

string

>= 1 characters <= 255 characters

Example

someCode

properties

object

externalUpdateDate

null | string format: date-time

Example

2018-12-15T00:00:23.114Z

cost

The actual cost for the merchant

null | number

Example

2.55

price

required

Price for the shopper

number

Example

3.5

unit

Unit the price applies to (pieces, kg, packs)

null | string

Example

kg

salePrice

Sale price

null | number

Example

msrp

Manufacturer’s suggested retail price

null | number

Example

4.5

minPrice

Lowest possible price (configurable product)

number

Example

maxPrice

Highest possible price (configurable product)

number

Example

7.5

volumePricing

Array<object>

object

minQty

required

null | number

Example

maxQty

required

null | number

Example

price

required

Price of the tier

number

Example

6.4

salePrice

Sale price of the tier

null | number

Example

unit

null | string

<= 30 characters

Example

kg

priceType

required

Fixed price, or relative to the standard price

string

Allowed values: fixed relative

Example

fixed

mapPricing

Array<object>

object

startDate

null | string format: date-time

Example

2018-12-12T14:27:23.114Z

endDate

null | string format: date-time

Example

2018-12-15T00:00:23.114Z

price

required

number

Example

10.1

currencyCode

required

string

Allowed values: AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN UYI UYU UYW UZS VES VND VUV WST XAF XAG XAU XBA XBB XBC XBD XCD XDR XOF XPD XPF XPT XSU XTS XUA XXX YER ZAR ZMW ZWL

Example

USD

Responses

200

Successfully set

application/json

object

errors

required

Array<object>

object

code

number

entity

string

entityId

string | object

entityIndex

integer

reason

string

catalogCode

string

subentityPath

Array<string | number>

validationErrors

Array<object>

object

code

Machine readable error code

string

Allowed values: ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_CREDENTIALS INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

Human readable error code

string

description

string

path

Array<string>

Example

{
  "errors": [
    {
      "code": 400,
      "entity": "planet",
      "entityId": "pluto",
      "entityIndex": 1,
      "reason": "Planet pluto was not found (did you mean dwarf planet pluto?)",
      "subentityPath": [
        "categories",
        0
      ],
      "validationErrors": [
        {
          "code": "MAX_LENGTH",
          "message": "Name too long",
          "description": "Property Name is too long",
          "path": [
            "name"
          ]
        }
      ]
    }
  ]
}

400

Validation error

application/json

object

statusCode

number

message

string

code

string

additionalInfo

object

validationErrors

Array<object>

object

code

number

reason

string

entity

string

entityId

string

subentityPath

Array<string | number>

error

object

paramName

The parameter-field, that failed to validate, like “userId”

string

paramValue

The value, that was sent, like “xxx”

null | string | number | array | object

code

Machine readable error code

string

Allowed values: SCHEMA_VALIDATION_FAILED VALIDATION_FAILED ENUM_MISMATCH MAXIMUM MAXIMUM_EXCLUSIVE MINIMUM MINIMUM_EXCLUSIVE MULTIPLE_OF ARRAY_LENGTH_LONG ARRAY_LENGTH_SHORT ARRAY_ADDITIONAL_ITEMS ARRAY_UNIQUE MAX_LENGTH MIN_LENGTH MAX_PROPERTIES MIN_PROPERTIES OBJECT_MISSING_REQUIRED_PROPERTY OBJECT_PROPERTIES_MAXIMUM OBJECT_PROPERTIES_MINIMUM OBJECT_ADDITIONAL_PROPERTIES OBJECT_DEPENDENCY_KEY ONE_OF_MISSING ONE_OF_MULTIPLE NOT_PASSED INVALID_FORMAT INVALID_TYPE UNKNOWN_FORMAT PATTERN

message

required

Human readable error code

string

results

object

errors

Array<object>

object

code

Machine readable error code

string

message

Human readable error code

string

description

string

path

Array<string>

warnings

array

Example

{
  "error": {
    "code": "SCHEMA_VALIDATION_FAILED",
    "results": {
      "errors": [
        {
          "code": "MAX_LENGTH",
          "message": "Name too long",
          "description": "Property Name is too long",
          "path": [
            "name"
          ]
        }
      ]
    }
  }
}

404

Merchant, location or product not found

application/json

object

statusCode

number

code

required

string

message

required

string

Example

{
  "code": "NotFound",
  "message": "Merchant not found"
}