PUT v1​/ sell​/shipping_profiles​/:id

Endpoint to edit a Shipping Profile

Instant gratification

Do it yourself from console! Assuming that you have a valid token previously exported into BEARER env variable

Try to edit a Shipping Profile
curl -i -H "Authorization: Bearer $BEARER" \
https://api.blomming.com/v1/sell/shipping_profiles/ \
-X PUT -d '{ "name":"National shipping", "origin_country_code":"IT", "everywhere_else_cost_single":10, "everywhere_else_cost_shared":5 }'

Request

Example Request

{
  "shipping_profile": {
    "name": "National Shipping",
    "origin_country_code": "IT",
    "everywhere_else_cost_single": 3.0,
    "everywhere_else_cost_shared": 4.0,
    "user_id": {
    },
    "item_id": {
    },
    "to_regions": [
      {
        "region_name": "European Union",
        "cost_single": 82.32,
        "cost_shared": 57.63
      }
    ],
    "to_countries": [
      {
        "country_code": "US",
        "cost_single": 233.0,
        "cost_shared": 181.1
      }
    ]
  }
}

Request Parameters

  • shipping_profile

    The Shipping Profile to create

    • Required: yes
    • name

      The name of the Shipping Profile

      • Required: yes
      • Type: string
      • Example: "National Shipping"
    • origin_country_code

      The country where the items is shipping from

      • Required: yes
      • Type: string
      • Example: "IT"
    • everywhere_else_cost_single

      The shipping cost when an item is shipped alone

      • Required: no
      • Type:
        • number
        • null
      • Example: 3.0
    • everywhere_else_cost_shared

      The shipping cost when an item is shipped together with other items. This value can be present only if also the everywhere_else_cost_single is not blank

      • Required: no
      • Type:
        • number
        • null
      • Example: 4.0
    • user_id

      the id of the user that is associated to this shipping profile

      • Required: yes
      • Type: fixnum
      • Example: 1
    • item_id

      the id of the item associated to this shipping profile

      • Required: yes
      • Type: fixnum
      • Example: 104
    • to_regions

      an array with the region to whom we can ship

      • Required: no
      • Type: array
      • Items

        a region to whom we can ship

        • Required: no
        • region_name

          the name of the region where we have to ship

          • Required: yes
          • Type: string
          • Example: "European Union"
        • cost_single

          the cost of the single shipping

          • Required: yes
          • Type: number
          • Example: 82.32
        • cost_shared

          the cost of the shared shipping

          • Required: yes
          • Type: number
          • Example: 57.63
    • to_countries

      A list of Countries where the ship is allowed.

      • Required: no
      • Type: array
      • Items

        a country to whom we can ship

        • Required: no
        • country_code

          the country code

          • Required: yes
          • Type: string
          • Example: "US"
        • cost_single

          cost of the single shipping to that country

          • Required: yes
          • Type: number
          • Example: 233.0
        • cost_shared

          cost of the shared shipping to that country

          • Required: yes
          • Type: number
          • Example: 181.1

Response

Example Response

{
  "id": 4347,
  "origin_country_code": "IT",
  "origin_country": "Italia",
  "everywhere_else_cost_single": 3.0,
  "everywhere_else_cost_shared": 4.0,
  "name": "second_profile",
  "everywhere_else": true,
  "item_id": {
  },
  "to_countries": [
    {
      "country_code": "US",
      "name": "Stati Uniti",
      "cost_single": 233.0,
      "cost_shared": 181.1
    }
  ],
  "to_regions": [
    {
      "name": "European Union",
      "cost_single": 82.32,
      "cost_shared": 57.63,
      "id": 1
    }
  ]
}

Response Parameters

  • id

    The shipping profile’s id

    • Required: yes
    • Type: string
    • Example: 4347
  • origin_country_code

    the country code of the country where the seller has the item

    • Required: yes
    • Type: string
    • Example: "IT"
  • origin_country

    the country where the seller has the item

    • Required: no
    • Type: string
    • Example: "Italia"
    • require: true
  • everywhere_else_cost_single

    The cost of a single object to be sent outside the region selected

    • Required: yes
    • Type: number
    • Example: 3.0
  • everywhere_else_cost_shared

    The cost of multiple objects to be sent outside the region selected

    • Required: yes
    • Type: number
    • Example: 4.0
  • name

    The name of the shipping profile

    • Required: yes
    • Type: string
    • Example: "second_profile"
  • everywhere_else

    whether is possible to ship outside the country or not

    • Required: no
    • Type: boolean
    • Example: true
  • item_id

    the id of the item associated to this shipping profile

    • Required: yes
    • Type: fixnum
    • Example: 104
  • to_countries

    A list of Countries where the ship is allowed.

    • Required: yes
    • Type: array
    • Items

      a country to whom we can ship

      • Required: no
      • country_code

        the country code

        • Required: yes
        • Type: string
        • Example: "US"
      • name

        the full name of the country

        • Required: yes
        • Type: string
        • Example: "Stati Uniti"
      • cost_single

        cost of the single shipping to that country

        • Required: yes
        • Type: number
        • Example: 233.0
      • cost_shared

        cost of the shared shipping to that country

        • Required: yes
        • Type: number
        • Example: 181.1
  • to_regions

    A list of Regions where the ship is allowed.

    • Required: yes
    • Type: array
    • Items

      a region to whom we can ship

      • Required: no
      • name

        the name of the region where we have to ship

        • Required: yes
        • Type: string
        • Example: "European Union"
      • cost_single

        the cost of the single shipping

        • Required: yes
        • Type: number
        • Example: 82.32
      • cost_shared

        the cost of the shared shipping

        • Required: yes
        • Type: number
        • Example: 57.63
      • id

        the region’s id

        • Required: yes
        • Type: integer
        • Example: 1

Response Codes

Successful Response Codes

Failure Response Codes