Skip to main content

shipping

Optional Field

This field is optional, but omitting it may leave out functionality on Prisjakt for your offers

Description​

The shipping attribute is used to set cost, time and methods of delivery. Please note, that shipping is required for all products sold on French market.

Effects When Used​

  • This information will be visible for the users in offer listing.

Validation Rules​

  • Submit complete shipping information
  • Handling time and transit time should be specified in days.
  • Overestimate if you can't provide accurate shipping cost
  • Submit shipping cost including VAT, use local currency
  • If you provide information about handling or transit time then min_handling_time should be lesser or equal to max_handling_time and min_transit_time should be lesser or equal to max_transit_time
  • Attribute carrier can be any string value up to 50 characters, but only the following values will be represented with icons airmee, best, bring, budbee, city, dachser, db, dhl, dooris, early, fedex, instabox, jetpak, postnord, ups, gls
  • Attribute delivery_type can only take specific enum values. If the provided value is not in the allowed enum values or is not provided, the status is unset. Allowed values are in_store_pickup, home, mailbox, package_locker, service_point

Best Practices​

Do​

  • Keep shipping information as precise as possible. Add multiple shipping attributes if shipping cost or time varies for different country, region or service.
  • If any of min_handling_time, max_handling_time, min_transit_time, max_transit_time is present then all those fields must be present for the current shipping item.

Don´t​

  • Don't provide comma or point as separator for both thousands and fractional part of the shipping price, i.e. we don't support 1,000,00 SEK and 1.000.00 SEK formats

Example Values​

Here are examples of how a valid shipping value should look like in XML and CSV (with header) respectively.

Valid Value
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>25.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>2</g:max_handling_time>
  <g:min_transit_time>1</g:min_transit_time>
  <g:max_transit_time>3</g:max_transit_time>
  <g:delivery_type>home</g:delivery_type>
  <g:carrier>PostNord</g:carrier>
</g:shipping>
Click to show more valid XML examples
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>25.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>2</g:max_handling_time>
  <g:min_transit_time>1</g:min_transit_time>
  <g:max_transit_time>3</g:max_transit_time>
  <g:delivery_type>home</g:delivery_type>
  <g:carrier>PostNord</g:carrier>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>New York</g:region>
  <g:service>Home Delivery</g:service>
  <g:price>5 SEK</g:price>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>London</g:region>
  <g:service>Standard</g:service>
  <g:price>0 GBP</g:price>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>25.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>2</g:max_handling_time>
  <g:min_transit_time>1</g:min_transit_time>
  <g:max_transit_time>3</g:max_transit_time>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>POST</g:service>
  <g:price>5.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>5</g:max_handling_time>
  <g:min_transit_time>1</g:min_transit_time>
  <g:max_transit_time>3</g:max_transit_time>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>45.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>8</g:max_handling_time>
  <g:min_transit_time>3</g:min_transit_time>
  <g:max_transit_time>10</g:max_transit_time>
</g:shipping>

Error Codes​

Below you will find possible error codes generated when validating this field alongside with an example in XML and CSV that would trigger the code. Please refer to the validation rules to understand the cause.

validation_missing_value
<g:shipping>
  <g:country></g:country>
  <g:region>New York</g:region>
  <g:service>Express</g:service>
  <g:price>5 SEK</g:price>
  <g:min_handling_time>-1</g:min_handling_time>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>New York</g:region>
  <g:service>Express</g:service>
  <g:price></g:price>
  <g:min_handling_time>-1</g:min_handling_time>
</g:shipping>
validation_shipping_time_missing_values
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>5.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>5.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>2</g:max_handling_time>
</g:shipping>
<g:shipping>
  <g:country>SE</g:country>
  <g:region>Skåne</g:region>
  <g:service>Express</g:service>
  <g:price>5.00 SEK</g:price>
  <g:min_handling_time>1</g:min_handling_time>
  <g:max_handling_time>2</g:max_handling_time>
  <g:min_transit_time>1</g:min_transit_time>
</g:shipping>

Properties​

PropertyValueDescription
Data TypeList[Nested]Closest data type in code
NestedTrueDefines if this field consists of one or more sub-fields
Case SensitiveFalseIf small or large letters matter for this field
RepeatableTrueIf you can supply multiple items of this field (it´s a list)
Repeatable limit100If a list, this specifices the max number of items

Changelog​

📅 2022-12-07

Added

Initial definition

📅 2024-04-16

Added

Added carrier and delivery_type support

References​