Please enable JavaScript.
Coggle requires JavaScript to display documents.
(definitions: (NewQuotationRequest: (required: (motherQuotationId,…
definitions:
NewQuotationRequest:
required:
motherQuotationId
affiliates
validityFrom
customerType
shippingCompany
type: object
properties:
motherQuotationId:
type: string
affiliates:
type: array
items:
$ref: '#/definitions/Affiliate'
validityFrom:
format: date-time
type: string
customerType:
type: string
shippingCompany:
type: string
Affiliate:
required:
partnerId
partnerType
main
validFrom
modifUser
type: object
properties:
partnerId:
type: string
partnerType:
type: string
main:
type: boolean
validFrom:
format: date-time
type: string
validTo:
format: date-time
type: string
modifUser:
type: string
GetQuotationRequest:
required:
pol
pod
shipCompCode
partnerCodes
simulationDate
equipment
type: object
properties:
pol:
type: string
pod:
type: string
shipCompCode:
type: string
partnerCodes:
type: array
items:
type: string
simulationDate:
format: date-time
type: string
equipment:
type: string
por:
type: string
fpd:
type: string
quoteRef:
type: string
nac:
type: string
CreateSQRequest:
required:
newSpecialQuotationRequest
newQuoteLineRequest
type: object
properties:
newSpecialQuotationRequest:
$ref: '#/definitions/NewSpecialQuotationRequest'
newQuoteLineRequest:
type: array
items:
$ref: '#/definitions/NewQuoteLineRequest'
NewSpecialQuotationRequest:
required:
quotationReference
quotationClass
shippingCompany
allInclusive
draft
decidingPartyRole
pricingGroups
affiliates
agency
quotationStatus
validityDateFrom
validityDateTo
creationUser
potentialUse
type: object
properties:
quotationReference:
type: string
externalQuotationId:
type: string
quotationClass:
type: string
shippingCompany:
type: string
allInclusive:
type: boolean
draft:
type: boolean
decidingPartyRole:
type: string
pricingGroups:
type: array
items:
$ref: '#/definitions/PricingGroups'
affiliates:
type: array
items:
$ref: '#/definitions/Affiliate'
agency:
type: string
quotationStatus:
type: string
validityDateFrom:
format: date-time
type: string
validityDateTo:
format: date-time
type: string
placeOfPayment:
type: string
urgent:
type: boolean
webPublished:
type: boolean
salesTerms:
type: string
creationUser:
type: string
dealPeriod:
type: string
eForwarder:
type: boolean
segmentId:
type: string
traffic:
type: string
potentialUse:
$ref: '#/definitions/PotentialUse'
NewQuoteLineRequest:
required:
quoteStatus
quoteType
portOfLoading
portOfDischarge
commodityCode
commodityType
pricedPackage
validityFrom
validityTo
exportmovementType
importmovementType
creationUser
tradeTariffBookId
type: object
properties:
quoteLineExternalId:
type: string
quoteStatus:
type: string
quoteType:
type: string
portOfLoading:
type: string
portOfDischarge:
type: string
commodityCode:
type: string
commodityType:
type: string
exportInlandPointCode:
type: string
importInlandPointCode:
type: string
exportPoolPointCode:
type: string
importPoolPointCode:
type: string
inlandconstruction:
type: string
shipperOwnedContainer:
type: boolean
nonOperatingReefer:
type: boolean
controlledAtmosphere:
type: boolean
hazardous:
type: boolean
reefer:
type: boolean
oversize:
type: boolean
dimensionsDetails:
$ref: '#/definitions/DimensionsDetails'
comment:
type: string
underDeck:
type: boolean
currencyCode:
type: string
pricedPackage:
$ref: '#/definitions/PricedPackage'
validityFrom:
format: date-time
type: string
validityTo:
format: date-time
type: string
exportmovementType:
type: string
importmovementType:
type: string
paymentMethod:
type: string
exportLinerTerms:
type: string
importLinerTerms:
type: string
routingComment:
type: string
creationUser:
type: string
tradeTariffBookId:
format: int32
type: integer
tadTariffBookId:
format: int32
type: integer
inlandExportTariffId:
format: int32
type: integer
inlandImportTariffId:
format: int32
type: integer
exportHaulageMode:
type: string
importHaulageMode:
type: string
exportZipCode:
type: string
importZipCode:
type: string
exportTransportMode:
type: string
importTransportMode:
type: string
exportDepotCode:
type: string
importDepotCode:
type: string
competitionRate:
type: string
premium:
type: boolean
nbSlots:
format: int32
type: integer
reeferDetails:
$ref: '#/definitions/ReeferDetails'
filingNumber:
format: int32
type: integer
amendmentCode:
type: string
quoteSurchargesExceptionsCreate:
type: array
items:
$ref: '#/definitions/SurchargeExceptionCreate'
PricingGroups:
required:
pricingGroupId
type: object
properties:
pricingGroupId:
type: string
prefferedUser:
type: string
PotentialUse:
required:
autoHazardous
autoFlatRack
autoOpenTop
autoReefer
autoTank
autoOversize
autoGarment
autoShipperOwned
type: object
properties:
autoHazardous:
type: boolean
autoFlatRack:
type: boolean
autoOpenTop:
type: boolean
autoReefer:
type: boolean
autoTank:
type: boolean
autoOversize:
type: boolean
autoGarment:
type: boolean
autoShipperOwned:
type: boolean
DimensionsDetails:
required:
unitOfmeasure
type: object
properties:
unitOfmeasure:
type: string
length:
format: int32
type: integer
width:
format: int32
type: integer
height:
format: int32
type: integer
ReeferDetails:
required:
temperature
ventilation
type: object
properties:
temperature:
format: int32
type: integer
ventilation:
format: int32
type: integer
SurchargeExceptionCreate:
required:
chargeCode
manualCharge
applicable
cargoOrBlLevel
createdUser
motivationComment
type: object
properties:
exceptionExternalId:
type: string
chargeCode:
type: string
manualCharge:
type: boolean
applicable:
type: boolean
allInclusive:
type: boolean
currencyCode:
type: string
surchargesRates:
$ref: '#/definitions/SurchargesRates'
textComment:
type: string
cargoOrBlLevel:
type: string
createdUser:
type: string
paymentMethod:
type: string
customerComment:
type: string
motivationComment:
type: string
calculationMode:
type: string
QuoteLine:
type: object
properties:
_id:
type: string
currStatus:
type: string
expMvtType:
type: string
impMvtType:
type: string
recPtCode:
type: string
polCode:
type: string
podCode:
type: string
origin:
type: string
destination:
type: string
delPtCode:
type: string
oogFlag:
type: string
socFlag:
type: string
hazFlag:
type: string
reeferFlag:
type: string
partners:
type: array
items:
$ref: '#/definitions/Partner'
tariff:
$ref: '#/definitions/Tariff'
equipments:
type: array
items:
$ref: '#/definitions/Equipment'
shipCompCode:
type: string
detailUid:
format: int32
type: integer
detUid:
format: int32
type: integer
commodities:
type: array
items:
$ref: '#/definitions/Commodity'
bulletCd:
type: string
fak:
type: string
mvtTypeFrom:
type: string
mvtTypeTo:
type: string
expMotCode:
type: string
impMotCode:
type: string
norFlag:
type: string
from:
format: date-time
type: string
to:
format: date-time
type: string
buildSrc:
type: string
recPstCode:
type: string
pickUpCode:
type: string
recDepotCode:
type: string
delPostCode:
type: string
dropOffCode:
type: string
delDepotCode:
type: string
caFlag:
type: string
ovrLength:
type: string
ovrWidth:
type: string
ovrHeight:
type: string
type:
type: string
temperature:
format: double
type: number
ventilation:
format: double
type: number
comm2Cust:
type: string
commtRouting:
type: string
expCstFlg:
type: string
impCstFlg:
type: string
trade:
$ref: '#/definitions/Trade'
grpCriteria:
type: string
lineSeq:
format: int32
type: integer
amendmntCode:
type: string
pubDate:
format: date-time
type: string
src:
type: string
basePrtCdOrig:
type: string
basePrtCdDest:
type: string
payMethCode:
type: string
partner:
$ref: '#/definitions/Partner'
fmcFlag:
type: string
allowedSqCreationFlag:
type: boolean
spotValidityInDays:
format: int32
type: integer
underDeck:
type: string
expLinrTerm:
type: string
impLinrTerm:
type: string
premium:
type: string
amendmentCode:
type: string
segmentUid:
type: string
Partner:
type: object
properties:
city:
type: string
code:
type: string
name:
type: string
type:
type: string
validFrom:
format: date-time
type: string
validTo:
format: date-time
type: string
quotation:
$ref: '#/definitions/Quotation'
Tariff:
type: object
properties:
type:
type: string
ref:
type: string
basedRateType:
type: string
Equipment:
type: object
properties:
price:
format: double
type: number
currCode:
type: string
taoRate:
format: double
type: number
taoRateCurrCd:
type: string
tadRate:
format: double
type: number
tadRateCurrCd:
type: string
code:
type: string
netWeight:
format: double
type: number
vol:
format: double
type: number
height:
format: double
type: number
width:
format: double
type: number
length:
format: double
type: number
sizeUOM:
type: string
Commodity:
type: object
properties:
type:
type: string
code:
type: string
name:
type: string
Trade:
type: object
properties:
appndxCode:
type: string
gvtTariffCode:
type: string
gvtTariffApp:
type: string
autoSOC:
type: string
autoHAZ:
type: string
autoFR:
type: string
autoOT:
type: string
autoRF:
type: string
autoTK:
type: string
autoOOG:
type: string
autoGOH:
type: string
name:
type: string
appndxUID:
type: string
Quotation:
type: object
properties:
type:
type: string
ref:
type: string
amendmntNbr:
format: int32
type: integer
GetQuoteLinesResult:
type: object
properties:
perfectMatch:
type: array
items:
$ref: '#/definitions/QuoteLine'
partialMatch:
type: array
items:
$ref: '#/definitions/QuoteLine'
NbResults:
format: int32
type: integer
readOnly: true
HasMatches:
type: boolean
readOnly: true
GetQuotationRefRequest:
type: object
properties:
partnerCodes:
type: array
items:
type: string
simulationDate:
format: date-time
type: string
PricingGroup:
type: object
properties:
cifPGId:
$ref: '#/definitions/TupleOfStringString'
fobPGId:
$ref: '#/definitions/TupleOfStringString'
TupleOfStringString:
type: object
properties:
m_Item1:
type: string
m_Item2:
type: string
GetCommoditiesByPricingGroupResponse:
type: object
properties:
_id:
format: int32
type: integer
code:
type: string
en:
type: string
fr:
type: string
pt:
type: string
es:
type: string
cn:
type: string
GetBestOfferRequest:
type: object
properties:
Poo:
type: string
Fpd:
type: string
Pol:
type: string
Pod:
type: string
Equipment:
type: string
PartnerCodes:
type: array
items:
type: string
Commodity:
$ref: '#/definitions/BestofferCommodity'
ShipCompCode:
type: string
SimulationDate:
format: date-time
type: string
CifId:
type: string
FobId:
type: string
POO:
type: string
FPD:
type: string
BestofferCommodity:
type: object
properties:
Code:
type: string
GroupCodes:
type: array
items:
type: string
GetBestOfferResult:
type: object
properties:
bestOffer:
$ref: '#/definitions/QuoteLine'
segmentData:
$ref: '#/definitions/SegmentData'
SegmentData:
type: object
properties:
cifPGId:
type: string
fobPGId:
type: string
cifSegment:
type: array
items:
$ref: '#/definitions/Segment'
fobSegment:
type: array
items:
$ref: '#/definitions/Segment'
segmentIds:
type: array
items:
type: string
readOnly: true
segmentFallback:
type: string
Segment:
type: object
properties:
segmentId:
type: string
ranking:
type: string
GetNacByPartnersRequest:
type: object
properties:
partnerCodes:
type: array
items:
type: string
pol:
type: string
pod:
type: string
PricedPackage:
type: object
properties:
packageCode1:
type: string
bofRate1:
type: string
maxWeight1:
format: int32
type: integer
bofRate2:
type: string
maxWeight2:
format: int32
type: integer
bofRate3:
type: string
maxWeight3:
format: int32
type: integer
bofRate4:
type: string
maxWeight4:
format: int32
type: integer
payingUnit:
type: string
SurchargesRates:
type: object
properties:
rateFor20DryOrReefer:
format: int32
type: integer
rateFor40DryOrReefer:
format: int32
type: integer
rateFor40DryOrReeferHighCube:
format: int32
type: integer
rateFor45DryOrReeferHighCube:
format: int32
type: integer
rateForSpecialEquipOrRoro:
format: int32
type: integer
TupleOfStringListOfGetNearByPortsResponse:
type: object
properties:
m_Item1:
type: string
m_Item2:
type: array
items:
$ref: '#/definitions/GetNearByPortsResponse'
GetNearByPortsResponse:
type: object
properties:
_id:
type: string
cmaNetwork:
type: boolean
nearby:
type: array
items:
$ref: '#/definitions/Nearby'
Nearby:
type: object
properties:
code:
type: string
priority:
format: int32
type: integer
NearByPortQuotesRequest:
type: object
properties:
LstNearByPortsResponse:
type: array
items:
$ref: '#/definitions/TupleOfStringListOfGetNearByPortsResponse'
GetQuoteLinesRquest:
$ref: '#/definitions/GetQuotationRequest'
GetPricingGroupRequest:
type: object
properties:
pol:
type: string
pod:
type: string
shipCompCode:
type: string
equipmentType:
type: string
GetCommoditiesByPricingGroupRequest:
type: object
properties:
pgCode:
type: array
items:
format: int32
type: integer
paths:
'/ecommerce/v2/quotations/{id}/{partnerCode}':
get:
tags:
Pricing
summary: Returns a quoteline for the given id and partner code
operationId: Pricing_GetByIdAsync
consumes: []
produces:
application/json
text/json
parameters:
name: id
in: path
description: id of the quoteline
required: true
type: string
name: partnerCode
in: path
description: partner code associated to quoteline
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/QuoteLine'
/ecommerce/v2/quotations:
post:
tags:
Pricing
summary: Creates a quotation
operationId: Pricing_CreateAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: test
required: true
schema:
$ref: '#/definitions/NewQuotationRequest'
responses:
'200':
description: OK
schema:
type: string
/ecommerce/v2/quotations/quotelines:
post:
tags:
Pricing
summary: Search for the quotelines corresponding to the given criteria
operationId: Pricing_GetQuoteLinesAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: ''
required: true
schema:
$ref: '#/definitions/GetQuotationRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/GetQuoteLinesResult'
'/ecommerce/v2/quotations/{shipCompCode}/{equipment}/{simulationDate}':
get:
tags:
Pricing
summary: Returns public quotelines corresponding to the given parameters
operationId: Pricing_GetPublicAsync
consumes: []
produces:
application/json
text/json
parameters:
name: equipment
in: path
description: ''
required: true
type: string
name: shipCompCode
in: path
description: ''
required: true
type: string
name: simulationDate
in: path
description: ''
required: true
type: string
format: date-time
name: pol
in: query
description: ''
required: false
type: string
name: pod
in: query
description: ''
required: false
type: string
name: por
in: query
description: ''
required: false
type: string
name: fpd
in: query
description: ''
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/GetQuoteLinesResult'
/ecommerce/v2/quotations/ref:
post:
tags:
Pricing
summary: Returns the quotation Reference for the given partners and Simulation date.
operationId: Pricing_GetQuotationRefByPartnersAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: ''
required: true
schema:
$ref: '#/definitions/GetQuotationRefRequest'
responses:
'200':
description: OK
schema:
type: array
items:
type: string
/ecommerce/v2/quotations/pricingGroup/findByPolPod:
get:
tags:
Pricing
summary: Returns the Pricing Group for the given parameters.
operationId: Pricing_GetPricingGroupAsync
consumes: []
produces:
application/json
text/json
parameters:
name: pol
in: query
description: ''
required: true
type: string
name: pod
in: query
description: ''
required: true
type: string
name: equipmentType
in: query
description: ''
required: true
type: string
name: shipCompCode
in: query
description: ''
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PricingGroup'
/ecommerce/v2/quotations/commodities/findByPgCode:
get:
tags:
Pricing
summary: This method is used for fetching the commodities by the pricing location groups
operationId: Pricing_GetCommoditiesByPricingGroupIdAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: pgCode
in: query
description: Segment IDs
required: true
type: array
items:
type: integer
format: int32
collectionFormat: multi
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/GetCommoditiesByPricingGroupResponse'
/ecommerce/v2/quotations/bestOffer:
post:
tags:
Pricing
summary: This method is used for fetching the best offers for IQ
operationId: Pricing_GetBestOfferAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: ''
required: true
schema:
$ref: '#/definitions/GetBestOfferRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/GetBestOfferResult'
/ecommerce/v2/quotations/nac:
post:
tags:
Pricing
summary: Returns the quotation NAC for the given partners.
operationId: Pricing_GetNacForPartnersAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: ''
required: true
schema:
$ref: '#/definitions/GetNacByPartnersRequest'
responses:
'200':
description: OK
schema:
type: array
items:
type: string
/ecommerce/v2/quotations/quotationHeaders:
post:
tags:
Pricing
summary: Create SQ From Tariff.
operationId: Pricing_CreateSQAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
description: ''
required: true
schema:
$ref: '#/definitions/CreateSQRequest'
responses:
'200':
description: OK
schema:
type: string
/ecommerce/v2/quotations/nearbyports:
post:
tags:
Pricing
summary: This method is used for fetching near by ports for IQ
operationId: Pricing_GetNearByPortsAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: dto
in: body
required: true
schema:
$ref: '#/definitions/GetQuotationRequest'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/TupleOfStringListOfGetNearByPortsResponse'
/ecommerce/v2/quotations/nearbyportquotes:
post:
tags:
Pricing
summary: This method is used for fetching quote results of near by ports for IQ
operationId: Pricing_GetNearByPortQuotesAsync
consumes:
application/json
text/json
produces:
application/json
text/json
parameters:
name: nearByPortQuotesRequest
in: body
required: true
schema:
$ref: '#/definitions/NearByPortQuotesRequest'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/GetQuoteLinesResult'
info:
version: v1
title: Ecommerce Pricing Api
schemes:
http
securityDefinitions:
oauth2:
type: oauth2
description: OAuth2 Implicit Grant
flow: implicit
tokenUrl: '
https://auth-int.cma-cgm.com:9031/as/token.oauth2
'
scopes:
'pricing:be': Performs read operations
swagger: '2.0'
host: 'localhost:62102'