Markets

Patch the list of shipment options.

delete/api/ShipmentOptions/{marketId}/ShipmentOption

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

marketIdstring required

Query parameters

shippingMethodIdstring nullable
shippingMethodNamestring nullable

Response

Success

shippingMethodIdstring nullable

Unique id for this option(if ShippingMethodName is not enough

shippingGatewaystring nullable

Provider gateway to use, e.g Bring, PostNord.

shippingPriceGatewaystring nullable

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"

shippingMethodNamestring nullable

Unique name to identify the shipping product. This value should match what the sales channel adds to an order and sends to OMS.

countryCodestring nullable

Two letter countryCode. Providers use this to get pickupPoints

shippingCompanystring nullable

If PickUp Point provider diff from ShippingGateway. GateWay is Logistra, and pickupPoint service is PostNord

shipmentProductstring nullable

The product to book. E.g "PICKUP_PARCEL", "mypack". Get this value from provider

shipmentProductNamestring nullable

Some providers need both ShipmentProduct and ShipmentProductName. Then ShipmentProduct will be "12543" and name "mypack"

providerNotificationboolean

If provider should use notifications(Send out sms/emails from Bring/Postnord)

shipmentReturnProductstring nullable

If return label should be created. Add provider name for return here. "MYPACK_COLLECT_RETURN"

shippingSubTotalnumber

Set if a default shipping cost is used

getPriceFromProviderboolean

Set if prices should be calculated by provider, based on cart/order and address

addTaxOnProviderPriceboolean

Should tax be added to provider shipping cost

additionalCustomerPricePercentagenumber

Most providers gives you a cost price for the shipment. If needed, add a surcharge here in percentage

discountedPricenumber

If there is a discounted price for the shipment

discountLabelstring nullable

Discount label

deliveryTimestring nullable

Default delivery time for this option

logoUrlstring nullable

Provider logo

vueTemplatestring nullable

Internal url to correct edit template

numberOfCollisMandatoryboolean

Set if it is mandatory to send in number of collies

shipmentDeliveryTypestring nullable

"Delivery" or "PickUp". "Delivery" is used when shipment is sent from store. "PickUp" is used when customer collect the shipment from store

translateKeystring nullable

Internal name for this shipment type. Use label for public

labelstring nullable

Friendly name for this shipment option.

labelTranslationKeystring nullable

Translation key for this shipment option.

descriptionstring nullable

A user friendly description of this shipment option

isDefaultShipmentboolean

Used internally as a fallback if no other shipment options is found

consigneeTypestring nullable

CONSUMER or BUSINESS, is used by providers. Check with correct provider

consignorTypestring nullable

CONSUMER or BUSINESS, is used by providers. Check with correct provider

defaultWarehouseCodestring nullable

Set if you use a default warehouse to send from

isWarehouseSetAutomaticallyboolean

Used if shipment options is added from Oms, and warehouse should be set automatically

providerServicesstring nullable

Provider specific values(comma separated) e.g "postnord_notification_email", "postnord_notification_sms"

hideInOmsboolean

Not visible in Oms gui

hideFromApiboolean

Not visible in public api

includeGoodsDescriptionboolean

Some providers needs a description of the goods. Then this should be true

externalShippingMethodNamestring nullable

Should be used for additional ID or mapping to external systems.

servicePointProviderstring nullable

If provider for pickUp/service points differ from ShippingGateway

servicePointRequiredboolean

If this shipment options require a pickUp/service point

getServicePointsboolean

If we should search for pickUp/service points, based on customer address

printerIdstring nullable

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

shouldParseDescriptionboolean

Used by special magento cases. Ask us if needed

validOnMarketsstring[] nullable

The markets this shipment option is valid for

taxRatenumber

Tax rate for the options, if differ from market tax rate. Only in used if we should calculate prices

shippingTaxnumber

Tax on shipping cost

shippingSubTotalExclTaxnumber

Shipping cost excl tax

discountedPriceTaxnumber

Discounted price tax

discountedPriceExclTaxnumber

Discounted price excl tax

discountAmountnumber

Amount of discount given to the customer

Changes

No recorded changes to this operation across all 1 revision of this API.