Patch the list of shipment options. If the patch object has same ShippingMethodId or ShippingMethodName, it modifies the shipping option. If not, id adds a new one.
Request
- Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
- URL: https://api.omnium.no/api/ShipmentOptions/{marketId}/ShipmentOption
- Auth: API key in header Authorization
Path parameters
Request body
Unique id for this option(if ShippingMethodName is not enough
Provider gateway to use, e.g Bring, PostNord.
If shipment prices and valid shipment options should be calculated by provider, but booking should not be done set ShippingPriceGateway to provider name, and set ShippingGateway to "Empty"
Unique name to identify the shipping product. This value should match what the sales channel adds to an order and sends to OMS.
Two letter countryCode. Providers use this to get pickupPoints
If PickUp Point provider diff from ShippingGateway. GateWay is Logistra, and pickupPoint service is PostNord
The product to book. E.g "PICKUP_PARCEL", "mypack". Get this value from provider
Some providers need both ShipmentProduct and ShipmentProductName. Then ShipmentProduct will be "12543" and name "mypack"
If provider should use notifications(Send out sms/emails from Bring/Postnord)
If return label should be created. Add provider name for return here. "MYPACK_COLLECT_RETURN"
Set if a default shipping cost is used
Set if prices should be calculated by provider, based on cart/order and address
Should tax be added to provider shipping cost
Most providers gives you a cost price for the shipment. If needed, add a surcharge here in percentage
If there is a discounted price for the shipment
Discount label
Default delivery time for this option
Provider logo
Internal url to correct edit template
Set if it is mandatory to send in number of collies
"Delivery" or "PickUp". "Delivery" is used when shipment is sent from store. "PickUp" is used when customer collect the shipment from store
Internal name for this shipment type. Use label for public
Friendly name for this shipment option.
Translation key for this shipment option.
A user friendly description of this shipment option
Used internally as a fallback if no other shipment options is found
CONSUMER or BUSINESS, is used by providers. Check with correct provider
CONSUMER or BUSINESS, is used by providers. Check with correct provider
Set if you use a default warehouse to send from
Used if shipment options is added from Oms, and warehouse should be set automatically
Provider specific values(comma separated) e.g "postnord_notification_email", "postnord_notification_sms"
Not visible in Oms gui
Not visible in public api
Some providers needs a description of the goods. Then this should be true
Should be used for additional ID or mapping to external systems.
If provider for pickUp/service points differ from ShippingGateway
If this shipment options require a pickUp/service point
If we should search for pickUp/service points, based on customer address
Used by providers that support cloud print Only in use if shipping option require special printer, else printer id should be on store. Ask us about setup
Used by special magento cases. Ask us if needed
The markets this shipment option is valid for
Tax rate for the options, if differ from market tax rate. Only in used if we should calculate prices
Tax on shipping cost
Shipping cost excl tax
Discounted price tax
Discounted price excl tax
Amount of discount given to the customer
Response
Success
Unique id for this option(if ShippingMethodName is not enough
Provider gateway to use, e.g Bring, PostNord.
If shipment prices and valid shipment options should be calculated by provider, but booking should not be done set ShippingPriceGateway to provider name, and set ShippingGateway to "Empty"
Unique name to identify the shipping product. This value should match what the sales channel adds to an order and sends to OMS.
Two letter countryCode. Providers use this to get pickupPoints
If PickUp Point provider diff from ShippingGateway. GateWay is Logistra, and pickupPoint service is PostNord
The product to book. E.g "PICKUP_PARCEL", "mypack". Get this value from provider
Some providers need both ShipmentProduct and ShipmentProductName. Then ShipmentProduct will be "12543" and name "mypack"
If provider should use notifications(Send out sms/emails from Bring/Postnord)
If return label should be created. Add provider name for return here. "MYPACK_COLLECT_RETURN"
Set if a default shipping cost is used
Set if prices should be calculated by provider, based on cart/order and address
Should tax be added to provider shipping cost
Most providers gives you a cost price for the shipment. If needed, add a surcharge here in percentage
If there is a discounted price for the shipment
Discount label
Default delivery time for this option
Provider logo
Internal url to correct edit template
Set if it is mandatory to send in number of collies
"Delivery" or "PickUp". "Delivery" is used when shipment is sent from store. "PickUp" is used when customer collect the shipment from store
Internal name for this shipment type. Use label for public
Friendly name for this shipment option.
Translation key for this shipment option.
A user friendly description of this shipment option
Used internally as a fallback if no other shipment options is found
CONSUMER or BUSINESS, is used by providers. Check with correct provider
CONSUMER or BUSINESS, is used by providers. Check with correct provider
Set if you use a default warehouse to send from
Used if shipment options is added from Oms, and warehouse should be set automatically
Provider specific values(comma separated) e.g "postnord_notification_email", "postnord_notification_sms"
Not visible in Oms gui
Not visible in public api
Some providers needs a description of the goods. Then this should be true
Should be used for additional ID or mapping to external systems.
If provider for pickUp/service points differ from ShippingGateway
If this shipment options require a pickUp/service point
If we should search for pickUp/service points, based on customer address
Used by providers that support cloud print Only in use if shipping option require special printer, else printer id should be on store. Ask us about setup
Used by special magento cases. Ask us if needed
The markets this shipment option is valid for
Tax rate for the options, if differ from market tax rate. Only in used if we should calculate prices
Tax on shipping cost
Shipping cost excl tax
Discounted price tax
Discounted price excl tax
Amount of discount given to the customer
Changes
No recorded changes to this operation across all 1 revision of this API.