Update selected partner delivery | omnicado-mall-proxy API documentation

Update selected partner delivery Deprecated

PUT /deliveries/partner/{code}

Replaced by /v2/transports endpoints.

Body Required

code string

Delivery method identifier. Allowed characters are: A-Z, a-z, 0-9, _, . and -.
title string

Title of delivery method
price number

Price of delivery method
cod_price number

Price of COD (cash on delivery)
free_limit number

Limit for free delivery, if there is no free_limit send null
delivery_delay number

Delivery delay in days
is_pickup_point boolean

If delivery method is pickup point
priority integer

Priority of delivery method
packageSize string

smallbox or bigbox package size

Values are smallbox or bigbox. Default value is smallbox.
weight object
Hide weight attributes Show weight attributes object
- min number
  
  Minimal weight in kg, 3 decimal points float format
- max number
  
  Maximal weight in kg, 3 decimal points float format
width object
Hide width attributes Show width attributes object
- min number
  
  Minimal width in cm, 1 decimal point float format
- max number
  
  Maximal width in cm, 1 decimal point float format
length object
Hide length attributes Show length attributes object
- min number
  
  Minimal length in cm, 1 decimal point float format
- max number
  
  Maximal length in cm, 1 decimal point float format
height object
Hide height attributes Show height attributes object
- min number
  
  Min height in cm, 1 decimal point float format
- max number
  
  Maximal height in cm, 1 decimal point float format

Responses

200

OK
Hide headers attributes Show headers attributes
- X-RateLimit-Limit string
  
  All available time windows applicable for request made, with the count of requests from smallest window as first value.
- X-RateLimit-Remaining integer
  
  The smallest amount of requests left for the time window.
- X-RateLimit-Reset integer
  
  Time in seconds until current window with lowest amount of requests resets
Hide response attribute Show response attribute object
- result object
  
  Hide result attributes Show result attributes object
  
  code integer(int)
  
  status string

PUT /deliveries/partner/{code}

curl \
 -X PUT https://mpapi.proxy.omnicado.com/v1/deliveries/partner/{code}?client_id=api_token_value \
 -H "Content-Type: application/json" \
 -d '{"code":"PD1","title":"Partner Delivery 1","price":99.99,"cod_price":39.99,"free_limit":1000,"delivery_delay":1,"is_pickup_point":true,"priority":1,"packageSize":"smallbox","weight":{"min":1.0,"max":80.0},"width":{"min":1.0,"max":10.0},"length":{"min":1.0,"max":100.0},"height":{"min":1.0,"max":10.0}}'

Request example

{
  "code": "PD1",
  "title": "Partner Delivery 1",
  "price": 99.99,
  "cod_price": 39.99,
  "free_limit": 1000,
  "delivery_delay": 1,
  "is_pickup_point": true,
  "priority": 1,
  "packageSize": "smallbox",
  "weight": {
    "min": 1.0,
    "max": 80.0
  },
  "width": {
    "min": 1.0,
    "max": 10.0
  },
  "length": {
    "min": 1.0,
    "max": 100.0
  },
  "height": {
    "min": 1.0,
    "max": 10.0
  }
}

Request examples

{
  "code": "PD1",
  "title": "Partner Delivery 1",
  "price": 99.99,
  "cod_price": 39.99,
  "free_limit": 1000,
  "delivery_delay": 1,
  "is_pickup_point": true,
  "priority": 1,
  "packageSize": "smallbox",
  "weight": {
    "min": 1.0,
    "max": 80.0
  },
  "width": {
    "min": 1.0,
    "max": 10.0
  },
  "length": {
    "min": 1.0,
    "max": 100.0
  },
  "height": {
    "min": 1.0,
    "max": 10.0
  }
}

Response examples (200)

# Headers
X-RateLimit-Limit: 2875, 5750;w=86400;name="partner:my_client_id|domain:other|unit:d", 2875;w=3600;name="partner:my_client_id|domain:other|unit:h", 17250;w=60;name="partner:my_client_id|domain:other|unit:m"
X-RateLimit-Remaining: 2871
X-RateLimit-Reset: 3527

# Payload
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}

Response examples (200)

# Headers
X-RateLimit-Limit: 2875, 5750;w=86400;name="partner:my_client_id|domain:other|unit:d", 2875;w=3600;name="partner:my_client_id|domain:other|unit:h", 17250;w=60;name="partner:my_client_id|domain:other|unit:m"
X-RateLimit-Remaining: 2871
X-RateLimit-Reset: 3527

# Payload
{
  "result": {
    "code": 200,
    "status": "OK"
  }
}