{"openapi":"3.0.1","info":{"title":"2Ship Carriers Connect API","version":"v1"},"paths":{"/api/CancelPickup/{CarrierId}":{"post":{"tags":["CancelPickup"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPickupRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelPickupRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CancelPickupRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CancelPickupResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/CancelPickupResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/CancelPickupResponse"}}}}}}},"/api/CarrierInfo/{CarrierId}":{"get":{"tags":["CarrierInfo"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"RequestId","in":"query","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CarrierInfoResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/CarrierInfoResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/CarrierInfoResponse"}}}}}}},"/api/CarrierLocations/{CarrierId}":{"post":{"tags":["CarrierLocations"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/LocationsRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/LocationsRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/LocationsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/LocationsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/LocationsResponse"}}}}}}},"/api/Close/{CarrierId}":{"post":{"tags":["Close"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/CloseRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CloseRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/CloseResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/CloseResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/CloseResponse"}}}}}}},"/api/Delete/{CarrierId}":{"post":{"tags":["Delete"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/DeleteRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/DeleteResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/DeleteResponse"}}}}}}},"/api/PickupAvailability/{CarrierId}":{"post":{"tags":["PickupAvailability"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PickupAvailabilityResponse"}}}}}}},"/api/Rate/{CarrierId}":{"post":{"tags":["Rate"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RateRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RateRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RateResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/RateResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RateResponse"}}}}}}},"/api/Register/{CarrierId}":{"post":{"tags":["Register"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/RegisterRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RegisterResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/RegisterResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RegisterResponse"}}}}}}},"/api/RequestPickup/{CarrierId}":{"post":{"tags":["RequestPickup"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PickupRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/PickupRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/PickupRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PickupResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PickupResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PickupResponse"}}}}}}},"/api/Ship/{CarrierId}":{"post":{"tags":["Ship"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/ShipRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/ShipRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ShipResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/ShipResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/ShipResponse"}}}}}}},"/api/Tracking/{CarrierId}":{"post":{"tags":["Tracking"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackingRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/TrackingRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/TrackingRequest"}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/TrackingResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/TrackingResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/TrackingResponse"}}}}}}},"/api/TrackingWebhook/{CarrierId}/{WebsiteId}/{ClientId}":{"post":{"tags":["TrackingWebhook"],"parameters":[{"name":"CarrierId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"WebsiteId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ClientId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{}},"text/json":{"schema":{}},"application/*+json":{"schema":{}}}},"responses":{"200":{"description":"Success","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/TrackingWebhookResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/TrackingWebhookResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/TrackingWebhookResponse"}}}}}}}},"components":{"schemas":{"Account":{"type":"object","properties":{"Name":{"type":"string","description":"Account Name","nullable":true},"Number":{"type":"string","description":"Account Number","nullable":true},"Currency":{"type":"string","description":"Account Currency","nullable":true},"Address":{"$ref":"#/components/schemas/Address"},"AccountDetails":{"type":"array","items":{"$ref":"#/components/schemas/AccountDetails"},"description":"All Other account details defined at setup of the carrier into carrier-connect","nullable":true}},"additionalProperties":false,"description":"Registering Account"},"AccountDetails":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false,"description":""},"AccountDetailsType":{"enum":["IsFlag","IsString","IsSelect"],"type":"string"},"AccountInfo":{"type":"object","properties":{"Number":{"type":"string","description":"Account Number","nullable":true},"Country":{"type":"string","description":"Account Country","nullable":true},"AccountDetails":{"type":"array","items":{"$ref":"#/components/schemas/AccountDetails"},"description":"All Other account details defined at setup of the carrier into carrier-connect","nullable":true}},"additionalProperties":false,"description":"Account info"},"Address":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Country Code","nullable":true},"CountryStateCode":{"type":"string","description":"Country State Code","nullable":true},"City":{"type":"string","description":"City","nullable":true},"PostalCode":{"type":"string","description":"Postal code","nullable":true},"Address1":{"type":"string","description":"Address 1","nullable":true},"Address2":{"type":"string","description":"Address 2","nullable":true},"Address3":{"type":"string","description":"Address 3","nullable":true},"IsResidential":{"type":"boolean","description":"Is Residential"}},"additionalProperties":false},"AddressPoint":{"type":"object","properties":{"Country":{"type":"string","description":"(Required) Country Code (ex: US, CA, RO...)","nullable":true},"State":{"type":"string","description":"(Optional) Country State","nullable":true},"City":{"type":"string","description":"(Optional) City","nullable":true},"PostalCode":{"type":"string","description":"(Required) Postal Code","nullable":true},"Address1":{"type":"string","description":"(Optional) Address1","nullable":true},"Latitude":{"type":"number","description":"(Optional) Latitude","format":"double","nullable":true},"Longitude":{"type":"number","description":"(Optional) Longitude","format":"double","nullable":true}},"additionalProperties":false,"description":"Address point"},"BillingOptions":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/BillingType"},"AccountNumber":{"type":"string","description":"Only required for Bill To Recipient or 3rd Party","nullable":true},"AccountAddress":{"$ref":"#/components/schemas/Company"},"ContractNumber":{"type":"string","description":"(Optional) Other number then the account number used by carriers","nullable":true}},"additionalProperties":false},"BillingType":{"enum":["Prepaid","Recipient","ThirdParty","Collect"],"type":"string","description":"billing type"},"CancelPickupAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"CancelPickupRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"PickupNumber":{"type":"string","description":"Pickup Number to be canceled","nullable":true}},"additionalProperties":false,"description":"Cancel Pickup Request"},"CancelPickupResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true}},"additionalProperties":false,"description":"Cancel Pickup Response"},"CargoTransportationType":{"enum":["PassengerAndCargoAircraft","CargoAircraftOnly","Ground","Highway"],"type":"string","description":"NAFTA Importer Specification"},"CarrierAccountDetails":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"Type":{"$ref":"#/components/schemas/AccountDetailsType"},"IsRequired":{"type":"boolean"},"SelectListOptions":{"type":"array","items":{"$ref":"#/components/schemas/SelectListAccountDetails"},"nullable":true},"AvailableOnlyWhenCountryCodeIs":{"type":"string","nullable":true}},"additionalProperties":false},"CarrierInfoResponse":{"type":"object","properties":{"RequestId":{"type":"string","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"Id":{"type":"string","format":"uuid"},"Id_In_2Ship":{"type":"integer","format":"int32"},"SCAC":{"type":"string","nullable":true},"Type":{"$ref":"#/components/schemas/CarrierType"},"Services":{"type":"array","items":{"$ref":"#/components/schemas/CarrierService"},"nullable":true},"APIDetails":{"$ref":"#/components/schemas/CarrierMethods"},"Language":{"$ref":"#/components/schemas/LanguageType"},"SpecialOptions":{"type":"array","items":{"$ref":"#/components/schemas/CarrierSpecialOption"},"nullable":true},"AccountDetails":{"type":"array","items":{"$ref":"#/components/schemas/CarrierAccountDetails"},"nullable":true},"PackagingTypes":{"type":"array","items":{"$ref":"#/components/schemas/CarrierPackagingType"},"nullable":true}},"additionalProperties":false,"description":"Carrier Info Response"},"CarrierLocation":{"type":"object","properties":{"Id":{"type":"string","description":"(Required) Id","nullable":true},"Name":{"type":"string","description":"(Required) Name","nullable":true},"LocationType":{"$ref":"#/components/schemas/CarrierLocationType"},"Latitude":{"type":"string","description":"(Required) GPS Latitude","nullable":true},"Longitude":{"type":"string","description":"(Required) GPS Longitude","nullable":true},"Postal":{"type":"string","description":"Postal","nullable":true},"City":{"type":"string","description":"(Required) City","nullable":true},"CountryStateCode":{"type":"string","description":"State","nullable":true},"CountryCode":{"type":"string","description":"(Required) Country code (2 letters country code)","nullable":true},"Address1":{"type":"string","description":"Address","nullable":true},"Address2":{"type":"string","description":"Address","nullable":true},"Address3":{"type":"string","description":"Address","nullable":true},"DistanceInKM":{"type":"number","description":"Distance - from requested address point to this location - if not specified will use google api to calc the distance - extra charges can apply","format":"double"},"Observations":{"type":"string","description":"Observations","nullable":true},"LocationTypeDescription":{"type":"string","description":"Location Type Description (Carrier Name, Client, Retail, APM Provider Name)","nullable":true},"Provider":{"type":"string","description":"Provider of the location (Your carrier name or other Provider name)","nullable":true},"MaxLength":{"type":"number","description":"Max length","format":"double","nullable":true},"MaxWidth":{"type":"number","description":"max Width","format":"double","nullable":true},"MaxHeight":{"type":"number","description":"max height","format":"double","nullable":true},"MaxWeight":{"type":"number","description":"max weight","format":"double","nullable":true},"MeasurementSystemMetric":{"type":"boolean","description":"Specify that the measurements types are in metric system (kilograms and centimeters). Default system is imperial(pounds and inches)","nullable":true}},"additionalProperties":false,"description":"Locker or Location item"},"CarrierLocationShipType":{"enum":["ShipFromAndShipTo","ShipFrom","ShipTo"],"type":"string"},"CarrierLocationType":{"enum":["CarrierLocation","RetailLocation","LockerBox"],"type":"string","description":"Specify the type of the ship to/from location"},"CarrierMethods":{"type":"object","properties":{"EndpointType":{"$ref":"#/components/schemas/EndpointType"},"RegisterAPI":{"type":"boolean"},"RateAPI":{"type":"boolean"},"ShipAPI":{"type":"boolean"},"TrackingAPI":{"type":"boolean"},"DeleteAPI":{"type":"boolean"},"CloseAPI":{"type":"boolean"},"PickupAPI":{"type":"boolean"},"LocationsAPI":{"type":"boolean"},"Register":{"$ref":"#/components/schemas/RegisterAPI"},"Rate":{"$ref":"#/components/schemas/RateAPI"},"Ship":{"$ref":"#/components/schemas/ShipAPI"},"Delete":{"$ref":"#/components/schemas/DeleteAPI"},"Close":{"$ref":"#/components/schemas/CloseAPI"},"Tracking":{"$ref":"#/components/schemas/TrackingAPI"},"Pickup":{"$ref":"#/components/schemas/PickupAPI"},"Locations":{"$ref":"#/components/schemas/LocationsAPI"}},"additionalProperties":false},"CarrierPackagingType":{"type":"object","properties":{"CarrierPackagingCode":{"type":"string","nullable":true},"TwoShipPackagingCode":{"$ref":"#/components/schemas/TwoShipPackagingCodeType"}},"additionalProperties":false},"CarrierService":{"type":"object","properties":{"Code":{"type":"string","description":"Service Code","nullable":true},"Name":{"type":"string","description":"Service Name","nullable":true},"Origin":{"type":"string","description":"Origin Country","nullable":true},"Destination":{"type":"string","description":"Destination Country","nullable":true}},"additionalProperties":false,"description":"Carrer Service"},"CarrierSpecialOption":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"Id_In_2Ship":{"type":"integer","format":"int32"},"PredefinedOption":{"$ref":"#/components/schemas/PredefinedOptionType"},"SubOptions":{"type":"array","items":{"$ref":"#/components/schemas/CarrierSubOption"},"nullable":true},"AvailableOnlyWhenCountryCodeIs":{"type":"string","nullable":true}},"additionalProperties":false},"CarrierSubOption":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/OptionType"},"Name":{"type":"string","nullable":true},"Code":{"type":"string","nullable":true},"RequestIndexIn2Ship":{"type":"integer","format":"int32"},"IsRequired":{"type":"boolean"},"SelectListOptions":{"type":"array","items":{"$ref":"#/components/schemas/SelectListCarrierOption"},"nullable":true}},"additionalProperties":false},"CarrierType":{"enum":["SmallPackages","SameDay","HeavyWeight","AirFreight","OceanFreight"],"type":"string"},"Client":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Country Code","nullable":true},"CountryStateCode":{"type":"string","description":"Country State Code","nullable":true},"City":{"type":"string","description":"City","nullable":true},"PostalCode":{"type":"string","description":"Postal code","nullable":true},"Address1":{"type":"string","description":"Address 1","nullable":true},"Address2":{"type":"string","description":"Address 2","nullable":true},"Address3":{"type":"string","description":"Address 3","nullable":true},"IsResidential":{"type":"boolean","description":"Is Residential"},"Firstname":{"type":"string","nullable":true},"Lastname":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"Email2":{"type":"string","nullable":true},"Tel":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Pager":{"type":"string","nullable":true},"Id":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Department":{"type":"string","nullable":true},"GLStore":{"type":"string","nullable":true},"GLSubStore":{"type":"string","nullable":true},"TaxNumber":{"type":"string","nullable":true},"ClientId":{"type":"integer","format":"int32"},"LanguageCode":{"type":"string","description":"Two letter ISO 639-1 code, for ex EN or FR (defaults to EN)","nullable":true}},"additionalProperties":false},"CloseAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"CloseDocument":{"type":"object","properties":{"Name":{"type":"string","description":"Document Name","nullable":true},"DocumentBase64String":{"type":"string","description":"Document Base 64 String - the document in Base64String format. is available just if RetrieveBase64Documents = true on Request","nullable":true},"EncodingType":{"$ref":"#/components/schemas/CloseDocumentEncodingType"}},"additionalProperties":false,"description":"Close Document"},"CloseDocumentEncodingType":{"enum":["PDF","CSV","HTML"],"type":"string","description":"EncodingType"},"CloseRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"GroupCode":{"type":"string","description":"Group code to Close","nullable":true},"ExcludedShipmentFromClose":{"type":"array","items":{"$ref":"#/components/schemas/ExcludedShipmentFromClose"},"description":"A list of individaul tracking numbers or/and shipment ids to be excluded from close. \r\nIf this field is populated then it close only that have the group code and are not closed yet excluding the shipments in this list","nullable":true}},"additionalProperties":false,"description":"Close Request"},"CloseResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"CloseDocuments":{"type":"array","items":{"$ref":"#/components/schemas/CloseDocument"},"description":"(Optional) A list of carrier close manifests","nullable":true}},"additionalProperties":false,"description":"Close Response"},"Commodity":{"type":"object","properties":{"Description":{"type":"string","description":"(Mandatory) Commodity Description","nullable":true},"MadeInCountryCode":{"type":"string","description":"(Optional) Country of manufacturer(CA, US, GB ... etc)","nullable":true},"Quantity":{"type":"number","description":"(Mandatory) Quantity","format":"double"},"QuantityUnitOfMeasure":{"type":"string","description":"(Mandatory) Commodity QuantityUnitOfMeasure (valid values: \"3MI\" - 3 Thousand Square Inches, \"ADJ\" - Adjustments, \"B56\" - 56 Pound Bushel, \"BBL\" - Barrel, \"BFT\" - Board Feet, \"BTU\" - British Thermal Unit, \"BU\" - Bushel, \"C\" - One Hundred or Celsius, \"CAR\" - Carat, \"CD\" - Cord, \"CFT\" - Cubic Foot/Feet, \"CG\" - Centigrams, \"CGM\" - Content Gram, \"CKG\" - Content Kilogram, \"CLB\" - Content Pound, \"CLF\" - One Hundred Leaves, \"CM\" - Centimeter, \"CM3\" - Cubic Centimeters, \"CRT\" - Crate, \"CSI\" - 100 Square Inches, \"CTN\" - Content Ton, \"CUR\" - Curie, \"CWT\" - Hundred Weight, \"CY\" - Clean Yield, \"CYD\" - Cubic Yard, \"CYG\" - Clean Yield Gram, \"CYK\" - Clean Yield Kilogram, \"DEG\" - Degree, \"DOZ\" - Dozen, \"LF\" - Leaf, \"LFT\" - Linear Foot, \"DPC\" - Dozen Pieces, \"DPR\" - Dozen Pair, \"E\" - Each, \"F\" - Fahrenheit, \"FT\" - Feet, \"G\" - Grams, \"GAL\" - Gallon, \"GR\" - Gross, \"GRL\" - Gross Lines, \"GRM\" - Gram, \"GRO\" - Gross, \"HUN\" - Hundreds, \"HZ\" - Hertz, \"JWL\" - Jewels, \"K\" - 1000, \"KG\" - Kilogram, \"KGM\" - Kilogram, \"KHZ\" - Kilohertz, \"KM\" - 1,000 Meters, \"KM2\" - 1,000 Square Meters, \"KM3\" - 1,000 Cubic Meters, \"KN\" - Kilo Newton, \"KPA\" - Kilopascal, \"KSB\" - 1,000 Standard Brick, \"KW\" - Kilowatts, \"KWH\" - Kilowatt-hours, \"L\" - Liter, \"LB\" - Pound, \"LBC\" - Pound Including Container, \"PFG\" - Proof Gallon, \"PFL\" - Proof Liter, \"LIN\" - Linear, \"LNM\" - Linear Meters, \"LTR\" - Liters, \"LYD\" - Linear Yard, \"M\" - Meters, \"M2\" - Square Meters, \"M3\" - Cubic Meters, \"MBE\" - Thousand Std Brick Equivalent, \"MBF\" - Thousand Board Feet, \"MBQ\" - Megabacquerel, \"MC\" - Millicurie, \"MCF\" - Thousand Cubic Feet, \"MET\" - Meters, \"MFT\" - Thousand Feet, \"MG\" - Milligram, \"ML\" - Milliliter, \"MLF\" - Thousand Linear Feet, \"MPA\" - Millipascal, \"MSF\" - Thousand Square Feet, \"MSI\" - Thousand Square Inches, \"MYD\" - Thousand Yards, \"NO\" - Number, \"OZ\" - Ounces, \"PAR\" - Pair, \"PC\" - Piece, \"PCS\" - Pieces, \"PK\" - Pack (Cards), \"PR\" - Pair, \"PRS\" - Pair or Pairs, \"PSI\" - Pounds Per Square Inch, \"QT\" - Quart, \"ROL\" - Roll, \"SBE\" - Standard Brick Equivalent, \"SFT\" - Square Foot, \"SQ\" - Square(s), \"SQI\" - Square Inch, \"STN\" - Short Ton, \"SYD\" - Square Yard, \"TOZ\" - Troy Ounce, \"X\" - Quantity Not Required, \"YD\" - Yard, \"YN\" - Yarn)","nullable":true},"UnitValue":{"type":"number","description":"(Mandatory) Commodity UnitValue","format":"double"},"ItemWeight":{"$ref":"#/components/schemas/Weight"},"ItemDimensions":{"$ref":"#/components/schemas/Dimensions"},"HarmonizedCode":{"type":"string","description":"(Optional) Commodity HarmonizedCode","nullable":true},"PartNumber":{"type":"string","description":"(Optional) Commodity PartNumber","nullable":true},"MarksOrNumbers":{"type":"string","description":"(Optional) Commodity MarksOrNumbers","nullable":true},"SKUOrItemOrUPC":{"type":"string","description":"(Optional) Commodity SKUOrItemOrUPC","nullable":true},"ExportLicense":{"type":"string","description":"(Optional) Commodity ExportLicense","nullable":true},"LicenseExpireDate":{"type":"string","description":"(Optional) Commodity LicenseExpireDate","format":"date-time","nullable":true},"NAFTA":{"type":"boolean","description":"(Optional) Commodity NAFTA"},"NAFTACommodityDetails":{"$ref":"#/components/schemas/NAFTACommodityDetails"},"FDA":{"type":"boolean","description":"(Optional) Commodity FDA"},"FCC":{"type":"boolean","description":"(Optional) Commodity FCC"},"SenderIsProducer":{"type":"boolean","description":"(Optional) Commodity SenderIsProducer"},"Textile":{"type":"boolean","description":"(Optional) Commodity Textile"},"TextileInformation":{"type":"string","description":"(Optional) Commodity TextileInformation","nullable":true},"FCCEntryNumber":{"type":"string","description":"(Optional) Commodity FCCEntryNumber","nullable":true},"FCCPortOfEntry":{"type":"string","description":"(Optional) Commodity FCCPortOfEntry","nullable":true},"FCCDeviceModel":{"type":"string","description":"(Optional) Commodity FCCDeviceModel","nullable":true},"FCCTradeName":{"type":"string","description":"(Optional) Commodity FCCTradeName","nullable":true},"FCCID":{"type":"string","description":"(Optional) Commodity FCCID","nullable":true},"FCCDescribeRadioFrequency":{"type":"string","description":"(Optional) Commodity FCCDescribeRadioFrequency","nullable":true},"IsDutiable":{"type":"boolean","description":"(Optional) Commodity IsDutiable"},"Manufacturer":{"$ref":"#/components/schemas/Company"},"AccessionNumber":{"type":"string","description":"(Optional) Commodity AccessionNumber","nullable":true},"QuantityAssignment":{"type":"array","items":{"$ref":"#/components/schemas/CommodityPacking"},"description":"(Optional) When Use this then PackageNumber will not be consider. link commodity quantity to diferent packages","nullable":true},"DangerousGoodsInfo":{"$ref":"#/components/schemas/DangerousGoods"},"LTLClassId":{"$ref":"#/components/schemas/FreightClass"},"NMFCItem":{"type":"string","description":"(Optional) Commodity NMFC Item","nullable":true},"NMFCSub":{"type":"string","description":"(Optional) Commodity NMFC Sub","nullable":true},"PlantArticle":{"type":"boolean","description":"(Optional)  if is set to true it specify that the Content described in commodity is Plant or Plant Product Article"},"PlantArticleGenus":{"type":"string","description":"For each article/component in block 13, enter the scientific name (see example below).\r\nIf the species of plant used to produce the product varies,and the species used to produce the product is unknown, enter each species that may have been used to produce the product.\r\nIf the product was manufactured prior to the Amendment and you cannot determine the species, enter \"special\" for Genus and \"pre-amendment\" for Species.\r\nNOTE:  The Scientific Name is NOT the trade/common name of the plant.","nullable":true},"PlantArticleSpecies":{"type":"string","description":"For each article/component in block 13, enter the scientific name (see example below).\r\nIf the species of plant used to produce the product varies,and the species used to produce the product is unknown, enter each species that may have been used to produce the product.\r\nIf the product was manufactured prior to the Amendment and you cannot determine the species, enter \"special\" for Genus and \"pre-amendment\" for Species.\r\nNOTE:  The Scientific Name is NOT the trade/common name of the plant.","nullable":true},"PlantArticleQuantity":{"type":"string","description":"Enter the quantity of plant material for every line that contains a different country of harvest and species pair.","nullable":true},"PlantArticlePercentRecycled":{"type":"number","description":"If the product is paper or paperboard, enter the percentage of recycled material it contains (0 - 100%). If the percentage of recycled material varies,enter the average percentage of recycled material used in the product (Example: If the percentage of recycled material used is between 25% and 45%, enter 35%).\r\nNOTE:Do not complete this  field if your imported product is NOT paper or paperboard.","format":"double"}},"additionalProperties":false,"description":"Commodity"},"CommodityPacking":{"type":"object","properties":{"PackageIndex":{"type":"integer","description":"(Mandatory) The (0-based) Index of the Packages - This will link the commodity to a specific package. - 0 mean first package, 1 mean second package... etc","format":"int32"},"Quantity":{"type":"number","description":"(Mandatory) The quantity linked to the package","format":"double"}},"additionalProperties":false,"description":"Commodity Packing"},"Company":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Country Code","nullable":true},"CountryStateCode":{"type":"string","description":"Country State Code","nullable":true},"City":{"type":"string","description":"City","nullable":true},"PostalCode":{"type":"string","description":"Postal code","nullable":true},"Address1":{"type":"string","description":"Address 1","nullable":true},"Address2":{"type":"string","description":"Address 2","nullable":true},"Address3":{"type":"string","description":"Address 3","nullable":true},"IsResidential":{"type":"boolean","description":"Is Residential"},"Firstname":{"type":"string","nullable":true},"Lastname":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"Email2":{"type":"string","nullable":true},"Tel":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Pager":{"type":"string","nullable":true},"Id":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Department":{"type":"string","nullable":true},"GLStore":{"type":"string","nullable":true},"GLSubStore":{"type":"string","nullable":true},"TaxNumber":{"type":"string","nullable":true}},"additionalProperties":false},"Contents":{"type":"object","properties":{"Documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"description":"(Optional) Contents(Documents) of your shipments","nullable":true},"Commodities":{"type":"array","items":{"$ref":"#/components/schemas/Commodity"},"description":"(Optional) Contents(Commodities) of your shipments (if this is present then will override documents if that are present)","nullable":true}},"additionalProperties":false,"description":"Contents"},"Cost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"}},"additionalProperties":false,"description":"Generic cost represented by a name and an amount."},"CurrencyExchangeRate":{"type":"object","properties":{"Date":{"type":"string","format":"date-time","readOnly":true},"FromCurrencyCode":{"type":"string","nullable":true,"readOnly":true},"ToCurrencyCode":{"type":"string","nullable":true,"readOnly":true},"ExchangeRate":{"type":"number","format":"double"}},"additionalProperties":false},"CustomPurpose":{"enum":["Sold","NotSold","Gift","Sample","RepairAndReturn","PersonalEffects","Merchandise","DangerousGoods","CommercialSample","HumanitarianDonation","Documents","Other","Warranty"],"type":"string","description":""},"CustomsAndDutiesCost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"}},"additionalProperties":false},"CustomsDeclaration":{"type":"object","properties":{"ImportExportType":{"$ref":"#/components/schemas/ImportExportType"},"ShipperAndExporterRelated":{"type":"boolean","description":""}},"additionalProperties":false,"description":""},"DangerousGoods":{"type":"object","properties":{"ContainsDangerousGoods":{"type":"boolean","description":"(Optional) if is set to true it specify that the Content described in commodity it contains Dangerous Goods / Hazardous Materials"},"Accessible":{"type":"boolean","description":"(Optional) Dangerous Goods Accessibility Type","nullable":true},"RegulationSet":{"$ref":"#/components/schemas/DGRegulationSet"},"RegulationLevelCode":{"$ref":"#/components/schemas/DGRegulationLevelCode"},"UN":{"type":"string","description":"(Optional) This is the ID number (UN/NA/ID) for the specified dangerous goods","nullable":true},"Class":{"type":"string","description":"(Optional) This is the hazard class associated to the specified dangerous goods","nullable":true},"PackingGroup":{"$ref":"#/components/schemas/DGPackingGroup"},"Authorization":{"type":"string","description":"(Optional) Dangerous Goods Authorization","nullable":true},"AdditionalHandlingInformation":{"type":"string","description":"(Optional) Specifies additional handling information for the current package","nullable":true},"TechnicalName":{"type":"string","description":"(Optional) Dangerous Goods TechnicalName","nullable":true},"AdditionalDescription":{"type":"string","description":"(Optional) Additional remarks or special provision information","nullable":true},"PackagingContainerType":{"type":"string","description":"(Optional) Specifies the concept of a container used to package dangerous goods commodities","nullable":true},"PackagingType":{"type":"string","description":"(Optional) The type of package used to contain the regulated good","nullable":true},"SignatureName":{"type":"string","description":"(Optional) Dangerous Goods Signature Name","nullable":true},"SignaturePlace":{"type":"string","description":"(Optional) Dangerous Goods Signature Place","nullable":true},"SignatureDate":{"type":"string","description":"(Optional) Dangerous Goods Signature Date","format":"date-time","nullable":true},"SignatureTitle":{"type":"string","description":"(Optional) Dangerous Goods Signature Title","nullable":true},"TransportType":{"$ref":"#/components/schemas/CargoTransportationType"},"DGPackingType":{"$ref":"#/components/schemas/DGPackingType"},"Radioactive":{"type":"boolean","description":"(Optional) Indicates the packaging type of the container used to package radioactive dangerous goods","nullable":true},"EmergencyPhone":{"type":"string","description":"(Optional) 24 Hour Emergency Phone Number","nullable":true},"EmergencyContact":{"type":"string","description":"(Optional) The emergency information, contact name and/or contract number","nullable":true},"AllPackedInOne":{"type":"boolean","description":"(Optional) Indicates if multiple, different hazmat/chemicals are contained within one box in a package","nullable":true},"OverPacked":{"type":"boolean","description":"(Optional) Indicates that one or more hazmat/chemicals are in separate boxes in a package","nullable":true},"QValue":{"type":"string","description":"(Optional) Indicates that the quantity of the dangerous goods packaged is permissible for shipping","nullable":true},"ChemicalRecord":{"type":"string","description":"(Optional) Dangerous Goods Chemical Record","nullable":true},"HazardLabelRequired":{"type":"string","description":"(Optional) Defines the type of label that is required on the package for the Dangerous Goods","nullable":true},"SubRiskClass":{"type":"string","description":"(Optional) Secondary hazardous characteristics of the specified dangerous goods","nullable":true},"TunelRestriction":{"type":"boolean","description":"(Optional) Dangerous Goods Through Road Tunnels Restriction","nullable":true},"AirportDeparture":{"type":"string","description":"(Optional) Dangerous Goods Airport of Departure","nullable":true},"AirportDestination":{"type":"string","description":"(Optional) Dangerous Goods Airport of Destination","nullable":true}},"additionalProperties":false,"description":"Dangerous Goods"},"DeleteAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"DeleteRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"TrackingNumber":{"type":"string","description":"Tracking Number to delete","nullable":true},"ShipmentId":{"type":"string","description":"Shipment id to delete","nullable":true},"ShipmentNumber":{"type":"string","description":"Shipment Master Number / PRO Number (for freight carriers)","nullable":true},"ShipmentDetails":{"$ref":"#/components/schemas/DeleteShipmentDetails"}},"additionalProperties":false,"description":"Delete Request"},"DeleteResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true}},"additionalProperties":false,"description":"Ship Response"},"DeleteShipmentDetails":{"type":"object","properties":{"Sender":{"$ref":"#/components/schemas/DeleteShipmentDetailsSender"},"Recipient":{"$ref":"#/components/schemas/DeleteShipmentDetailsRecipient"}},"additionalProperties":false,"description":"Shipment Details"},"DeleteShipmentDetailsRecipient":{"type":"object","properties":{"Email":{"type":"string","description":"Email","nullable":true}},"additionalProperties":false,"description":"Recipient"},"DeleteShipmentDetailsSender":{"type":"object","properties":{"Email":{"type":"string","description":"email","nullable":true}},"additionalProperties":false,"description":"Sender"},"Delivery":{"type":"object","properties":{"TransitDays":{"type":"integer","format":"int32"},"DeliveryDate":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"Estimated delivery information for a shipment."},"DGPackingGroup":{"enum":["NONE","I","II","III"],"type":"string","description":"NAFTA Importer Specification"},"DGPackingType":{"enum":["OTHER","FIBERBOARDBOX","WOODBOX","PLASTICJERRICAN","PLASTICBOX","PLASTICDRUM","PLASTICPAIL","METALBOX","STEELDRUM","STEELJERRICAN","STEELBOX","STYROFOAMBOX","CYLINDER","ENVIROTAINER","PLYWOODBOX","PLYWOODDRUM","FIBERDRUM","CARTON","ALUMINUMDRUM","ALUMINUMCYLINDERS","ALUMINUMJERRICAN","ALUMINUMBOX"],"type":"string","description":"NAFTA Importer Specification"},"DGRegulationLevelCode":{"enum":["FullyRegulated","LimitedQuantity","ExceptedQuantity","LimitedRegulated"],"type":"string","description":"NAFTA Importer Specification"},"DGRegulationSet":{"enum":["CFR","TDG","IATA","ADR"],"type":"string","description":"NAFTA Importer Specification"},"Dimensions":{"type":"object","properties":{"Length":{"type":"number","format":"double"},"Width":{"type":"number","format":"double"},"Height":{"type":"number","format":"double"},"Type":{"$ref":"#/components/schemas/DimensionType"}},"additionalProperties":false,"description":"Immutable class, used for package dimensions."},"DimensionType":{"enum":["Inches","Centimeters"],"type":"string"},"Document":{"type":"object","properties":{"Description":{"type":"string","description":"(Mandatory) Document Description","nullable":true},"UnitValue":{"type":"number","description":"(Mandatory) Document Unit Value","format":"double"},"MadeInCountryCode":{"type":"string","description":"(Optional) Document Country of manufacturer","nullable":true},"IsDutiable":{"type":"boolean","description":"(Optional) if the document is dutiable"}},"additionalProperties":false,"description":"Document"},"DocumentType":{"enum":["Image","PDF"],"type":"string","description":"Document Type"},"EncodingType":{"enum":["PDF","PNG","ZPL2"],"type":"string","description":"EncodingType"},"EndpointType":{"enum":["Local","Remote"],"type":"string"},"ErrorMessage":{"type":"object","properties":{"Code":{"type":"string","nullable":true},"Message":{"type":"string","nullable":true}},"additionalProperties":false},"ExcludedShipmentFromClose":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"Tracking Number to be excluced from close transaction","nullable":true},"ShipmentId":{"type":"string","description":"Shipment Id to be exluced from close transaction","nullable":true}},"additionalProperties":false,"description":"Exlcluded shipment from close transaction of a group of shipments"},"FreightClass":{"enum":["None","F50","F55","F60","F65","F70","F77_5","F85","F92_5","F100","F110","F125","F150","F175","F200","F250","F300","F400","F500"],"type":"string"},"FreightCost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"}},"additionalProperties":false,"description":"This is the base charge for the freight transportation alone, without any other surcharges or taxes."},"FreightInfo":{"type":"object","properties":{"Description":{"type":"string","description":"Description of freight","nullable":true},"FreightClass":{"$ref":"#/components/schemas/FreightClass"},"PackagesInPallet":{"type":"integer","description":"Number if Pacakges on the Pallet/skid","format":"int32"},"IsStackable":{"type":"boolean","description":"Specify if the pallet/skid is stackable"},"NMFCItem":{"type":"string","description":"NMFC Item","nullable":true},"NMFCSub":{"type":"string","description":"NMFC Sub","nullable":true}},"additionalProperties":false,"description":"Skid"},"FuelCost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"},"Type":{"$ref":"#/components/schemas/PercentageCalculationType"},"BaseCost":{"$ref":"#/components/schemas/Cost"},"Percentage":{"type":"number","description":"Usually between 0 and 1, for example a 35% discount should be set as 0.35, and a 200% markup must be set as 2.0","format":"double"}},"additionalProperties":false,"description":"Usually calculated on top of the freight, but optionally may include additional surcharges as well."},"ImportExportType":{"enum":["Permanent","Temporary","Repair","Return"],"type":"string","description":""},"InternationalOptions":{"type":"object","properties":{"CustomsBillingOptions":{"$ref":"#/components/schemas/BillingOptions"},"Invoice":{"$ref":"#/components/schemas/Invoice"},"CustomsDeclaration":{"$ref":"#/components/schemas/CustomsDeclaration"}},"additionalProperties":false,"description":"InternationalOptions"},"Invoice":{"type":"object","properties":{"Currency":{"type":"string","description":"(Optional) Invoice Currency","nullable":true},"TermsOfSale":{"$ref":"#/components/schemas/TermsOfSaleType"},"CertificateNumber":{"type":"string","description":"Certificate Number (Code:4108)","nullable":true},"Purpose":{"$ref":"#/components/schemas/CustomPurpose"},"UploadCustomsDocumentsElectronically":{"type":"boolean","description":"Upload Customs Documents Electronically (Code:791)"}},"additionalProperties":false,"description":"Invoice"},"LabelPrintPreferencesType":{"type":"object","properties":{"Encoding":{"$ref":"#/components/schemas/EncodingType"},"OutputFormat":{"$ref":"#/components/schemas/OutputFormatType"}},"additionalProperties":false,"description":"LabelPrintPreferencesType"},"LanguageType":{"enum":["English","French","German","Spanish","Romanian"],"type":"string"},"Location":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Country Code","nullable":true},"CountryStateCode":{"type":"string","description":"Country State Code","nullable":true},"City":{"type":"string","description":"City","nullable":true},"PostalCode":{"type":"string","description":"Postal code","nullable":true},"Address1":{"type":"string","description":"Address 1","nullable":true},"Address2":{"type":"string","description":"Address 2","nullable":true},"Address3":{"type":"string","description":"Address 3","nullable":true},"IsResidential":{"type":"boolean","description":"Is Residential"},"LocationId":{"type":"integer","format":"int32"},"Name":{"type":"string","nullable":true},"Tel":{"type":"string","nullable":true},"ContactName":{"type":"string","nullable":true},"CompanyName":{"type":"string","nullable":true}},"additionalProperties":false},"LocationOrAPMInfo":{"type":"object","properties":{"Id":{"type":"string","description":"Id","nullable":true},"PostalCode":{"type":"string","description":"Postal","nullable":true},"City":{"type":"string","description":"City","nullable":true},"CountryStateCode":{"type":"string","description":"State","nullable":true},"CountryCode":{"type":"string","description":"Country","nullable":true},"Address1":{"type":"string","description":"Address1","nullable":true},"Address2":{"type":"string","description":"Address","nullable":true},"Address3":{"type":"string","description":"Address","nullable":true},"Name":{"type":"string","description":"Location Name","nullable":true}},"additionalProperties":false},"LocationsAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true},"Type":{"$ref":"#/components/schemas/CarrierLocationShipType"},"LockerBoxesAvailable":{"type":"boolean"},"CarrierLocationsAvailable":{"type":"boolean"}},"additionalProperties":false},"LocationsRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"AddressPoint":{"$ref":"#/components/schemas/AddressPoint"},"GetLockers":{"type":"boolean","description":"(Required) Flag - specify to include lockers"},"GetCarrierLocations":{"type":"boolean","description":"(Required) Flag - specify to include Carrier Locations"},"GetRetailLocations":{"type":"boolean","description":"(Required) Flag - specify to include Retail Locations"},"LocationsType":{"$ref":"#/components/schemas/LocationsType"},"MaxDistanceToLocationInKM":{"type":"number","description":"(Optional) Specify the max distance to lockers/location in KM - default value is 10 - max value is 100","format":"double"},"MaxNumberOfLocationsReturned":{"type":"integer","description":"(Optional) Spcify the max number of places returned  - default value is 20 - max value is 100","format":"int32"}},"additionalProperties":false,"description":"Get Carrier Locations (Lockers or Carriers pickup/drop of locations)"},"LocationsResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"Locations":{"type":"array","items":{"$ref":"#/components/schemas/CarrierLocation"},"description":"Locations/Lockers list","nullable":true}},"additionalProperties":false,"description":"Get ship to/from Lockers and Locations Response"},"LocationsType":{"enum":["ShipTo","ShipFrom"],"type":"string","description":"Get Locations Type"},"Money":{"type":"object","properties":{"Amount":{"type":"number","format":"double"},"Currency":{"type":"string","nullable":true}},"additionalProperties":false},"MPSPricingType":{"enum":["None","ByTotalWeight","RateEachPackage"],"type":"string","description":"The pricing method used to calculate freight cost (ByTotalWeight results in cheaper costs compared to RateEachPackage)."},"NAFTACommodityDetails":{"type":"object","properties":{"PreferenceCriterion":{"$ref":"#/components/schemas/NaftaPreferenceCriterion"},"ProducerDetermination":{"$ref":"#/components/schemas/NaftaProducerDetermination"},"NaftaNetCost":{"$ref":"#/components/schemas/NaftaNetCostMethod"},"NetCostBeginDate":{"type":"string","description":"NAFTA Net Cost Method Begin Date","format":"date-time","nullable":true},"NetCostEndDate":{"type":"string","description":"NAFTA Net Cost Method Ending Date","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Set details of commodity for NAFTA"},"NaftaNetCostMethod":{"enum":["NC","NO"],"type":"string","description":"NAFTA Net Cost Method"},"NaftaPreferenceCriterion":{"enum":["A","B","C","D","E","F"],"type":"string","description":"NAFTA Preference Criterion"},"NaftaProducerDetermination":{"enum":["YES","NO_1","NO_2","NO_3"],"type":"string","description":"NAFTA Producer Determination"},"OptionDetail":{"type":"object","properties":{"Code":{"type":"string","description":"Unique Code for a special option to identify the the detail","nullable":true},"Value":{"type":"string","description":"The value of the Special Option Detail","nullable":true}},"additionalProperties":false,"description":"Other Detail of a Carrier Special Option"},"OptionType":{"enum":["IsFlag","IsString","IsNumeric","IsDate","IsDateAndTime","IsTime","IsCountryListSelect","IsProvinceListSelect","IsWeightTypeSelect","IsDimensionTypeSelect","IsCurrencyTypeSelect","IsAddress","IsSelect"],"type":"string"},"OtherDocument":{"type":"object","properties":{"DocumentName":{"type":"string","description":"Document Name","nullable":true},"DocumentBase64String":{"type":"string","description":"Document Base64","nullable":true},"DocumentType":{"$ref":"#/components/schemas/DocumentType"}},"additionalProperties":false,"description":"Tracking other Document"},"OutputFormatType":{"enum":["Laser","Thermal"],"type":"string","description":"Size of the label"},"Package":{"type":"object","properties":{"Weight":{"$ref":"#/components/schemas/Weight"},"Dimensions":{"$ref":"#/components/schemas/Dimensions"},"PackagingCode":{"type":"string","description":"Packageing Code","nullable":true},"DeclaredValue":{"$ref":"#/components/schemas/Money"},"References":{"$ref":"#/components/schemas/References"},"FreightInfo":{"$ref":"#/components/schemas/FreightInfo"},"PreAssignTrackingNumber":{"$ref":"#/components/schemas/PreAssignTrackingNumber"}},"additionalProperties":false,"description":"Package Info (or skid/pallet when the carrier is a freight carrier)"},"PackageDocument":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/PackageDocumentType"},"DocumentBase64String":{"type":"string","description":"Document Base 64 String - the document in Base64String format.","nullable":true},"Encoding":{"$ref":"#/components/schemas/ShippingDocumentEncodingType"}},"additionalProperties":false,"description":"Shippping Document"},"PackageDocumentType":{"enum":["ShippingLabel","ReturnLabel","Other"],"type":"string","description":"Document Type"},"PackagesInfo":{"type":"object","properties":{"Packages":{"type":"array","items":{"$ref":"#/components/schemas/Package"},"description":"The list of the packages/skids/pallets","nullable":true}},"additionalProperties":false,"description":"Packages / Skids / Pallets info"},"PercentageCalculationType":{"enum":["Percentage","Discount","Markup"],"type":"string","description":"Used in PercentageCost, to indicate the type of calculation."},"PickupAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true},"PickupAvailabilityAPI":{"type":"boolean"},"PickupAvailability":{"$ref":"#/components/schemas/PickupAvailabilityAPI"},"CancelPickupAPI":{"type":"boolean"},"CancelPickup":{"$ref":"#/components/schemas/CancelPickupAPI"}},"additionalProperties":false},"PickupAvailabilityAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"PickupAvailabilityRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"PickupLocation":{"$ref":"#/components/schemas/PickupLocation"},"PickupDate":{"type":"string","description":"Pickup Date","format":"date-time"}},"additionalProperties":false,"description":"Pickup Availability Request"},"PickupAvailabilityResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"PickupIsAvailable":{"type":"boolean","description":"Spcify if the Pickup can be scheduled for the requested date and locations"}},"additionalProperties":false,"description":"Pickup Availability Response"},"PickupContact":{"type":"object","properties":{"Firstname":{"type":"string","description":"First Name","nullable":true},"Lastname":{"type":"string","description":"Last Name","nullable":true},"Email":{"type":"string","description":"Email","nullable":true},"Email2":{"type":"string","description":"secondary email","nullable":true},"Tel":{"type":"string","description":"Telephone Number","nullable":true}},"additionalProperties":false,"description":"Pickup Address"},"PickupDetails":{"type":"object","properties":{"ReadyTime":{"type":"string","description":"(Optional) the time of day (HH:mm) when the shipments are ready","nullable":true},"CompanyCloseTime":{"type":"string","description":"(Optional) the time of day (HH:mm) when the company close","nullable":true}},"additionalProperties":false,"description":"Pickup Details"},"PickupDocument":{"type":"object","properties":{"Name":{"type":"string","description":"Document Name","nullable":true},"DocumentBase64String":{"type":"string","description":"Document Base 64 String - the document in Base64String format.","nullable":true},"Encoding":{"$ref":"#/components/schemas/PickupDocumentEncodingType"}},"additionalProperties":false,"description":"Shippping Document"},"PickupDocumentEncodingType":{"enum":["PDF","CSV"],"type":"string","description":"EncodingType"},"PickupLocation":{"type":"object","properties":{"CountryCode":{"type":"string","description":"Country Code","nullable":true},"CountryStateCode":{"type":"string","description":"Country State Code","nullable":true},"City":{"type":"string","description":"City","nullable":true},"PostalCode":{"type":"string","description":"Postal code","nullable":true},"Address1":{"type":"string","description":"Address 1","nullable":true},"Address2":{"type":"string","description":"Address 2","nullable":true},"Address3":{"type":"string","description":"Address 3","nullable":true},"IsResidential":{"type":"boolean","description":"Is Residential"},"CompanyName":{"type":"string","description":"Company Name","nullable":true}},"additionalProperties":false,"description":"Pickup Location"},"PickupRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"PickupLocation":{"$ref":"#/components/schemas/PickupLocation"},"Contact":{"$ref":"#/components/schemas/PickupContact"},"PickupInstructions":{"type":"string","description":"Pickup Instructions","nullable":true},"PickupDate":{"type":"string","description":"Pickup Date","format":"date-time"},"ReadyTime":{"type":"string","description":"(Optional) the time of day (HH:mm) when the shipments are ready for pickup","nullable":true},"CompanyCloseTime":{"type":"string","description":"(Optional) the time of day (HH:mm) when the company close","nullable":true},"PickupShipmentsInfo":{"$ref":"#/components/schemas/PickupShipments"}},"additionalProperties":false,"description":"Pickup Request"},"PickupResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"PickupNumber":{"type":"string","description":"Pickup Number","nullable":true},"PickupDocuments":{"type":"array","items":{"$ref":"#/components/schemas/PickupDocument"},"description":"Pickup Documents","nullable":true}},"additionalProperties":false,"description":"Pickup Response"},"PickupShipments":{"type":"object","properties":{"PackagesCount":{"type":"integer","description":"Packages / Pallets (Freight Carriers) Count","format":"int32"},"TotalWeight":{"$ref":"#/components/schemas/Weight"},"MediumPackageDimensions":{"$ref":"#/components/schemas/Dimensions"},"ShipmentsListForPickup":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentForPickup"},"description":"(Optional) A list of individual tracking numbers and/or shipment numbers (or pro numbers) for wich it should create a pickup","nullable":true}},"additionalProperties":false,"description":"Pickup shipments"},"PreAssignTrackingNumber":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"main number","nullable":true},"TrackingNumberPrefix":{"type":"string","description":"Prefix component","nullable":true},"TrackingNumberSufix":{"type":"string","description":"sufix component","nullable":true}},"additionalProperties":false,"description":"PreAssignTrackingNumber object - the final tracking number sent to carrier is [TrackingNumberPrefix]+[TrackingNumber]+[TrackingNumberSufix]+[CheckDigit] (CheckDigit it is calculated in your implementation - it is not comming from 2ship - just if your carrier has a check digit calculation)"},"PredefinedOptionType":{"enum":["NotSet","SaturdayDelivery","SaturdayPickUp","CollectOnDelivery","SignatureRequired","DangerouseGoods","CheckOnDelivery"],"type":"string"},"Price":{"type":"object","properties":{"PackageIndex":{"type":"integer","description":"Zero represents a total cost for the entire shipment.","format":"int32"},"ServiceCode":{"type":"string","description":"The carrier service code for this price","nullable":true},"ServiceName":{"type":"string","description":"The carrier service code for this price","nullable":true},"RateQuoteNumber":{"type":"string","description":"Some carriers return a unique identifier for loging purposes","nullable":true},"PackagingCode":{"type":"string","description":"Carrier specific packaging code (can be null)","nullable":true},"RatedWeight":{"$ref":"#/components/schemas/Weight"},"Freight":{"$ref":"#/components/schemas/FreightCost"},"Fuel":{"$ref":"#/components/schemas/FuelCost"},"Surcharges":{"type":"array","items":{"$ref":"#/components/schemas/SurchargeCost"},"description":"All surcharges, except fuel.","nullable":true},"Taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxCost"},"description":"All government taxes.","nullable":true},"CustomsAndDuties":{"type":"array","items":{"$ref":"#/components/schemas/CustomsAndDutiesCost"},"description":"Usually applied for international shipping.","nullable":true},"Delivery":{"$ref":"#/components/schemas/Delivery"},"RateZone":{"$ref":"#/components/schemas/RateZone"},"CurrencyCode":{"type":"string","description":"Price Currency","nullable":true},"ExchangeRate":{"$ref":"#/components/schemas/CurrencyExchangeRate"},"ServiceInfo":{"type":"string","description":"Service Information","nullable":true},"Total":{"type":"number","description":"Total cost","format":"double","readOnly":true}},"additionalProperties":false,"description":"Immutable freight price structure for a package or a shipment."},"RateAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"RateRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"SourceOfOrder":{"type":"string","description":"(Optional) Source of the order","nullable":true},"OrderNumber":{"type":"string","description":"(Optional) Order number","nullable":true},"ServiceCode":{"type":"string","description":"(Optional) Carrier Service Code","nullable":true},"Sender":{"$ref":"#/components/schemas/Company"},"Recipient":{"$ref":"#/components/schemas/Company"},"PackagesInfo":{"$ref":"#/components/schemas/PackagesInfo"},"PickupDate":{"type":"string","description":"The date of the pickup (default is today)","format":"date-time"},"Billing":{"$ref":"#/components/schemas/BillingOptions"},"SpecialOptions":{"type":"array","items":{"$ref":"#/components/schemas/SpecialOption"},"description":"(Optional) Carrier Specific Special Options","nullable":true},"Contents":{"$ref":"#/components/schemas/Contents"},"PickupDetails":{"$ref":"#/components/schemas/PickupDetails"},"ShipToLocationOrAPM":{"type":"boolean","description":"(Optional) Specify if the request is to ship the order to an APM/lOCKER or a fixed location: carrier location or a retail location"},"ShipToLocationOrAPMInfo":{"$ref":"#/components/schemas/LocationOrAPMInfo"},"ShipFromLocationOrAPM":{"type":"boolean","description":"(Optional) Specify if the request is to ship the order from an APM/lOCKER or a fixed location: carrier location or a retail location"},"ShipFromLocationOrAPMInfo":{"$ref":"#/components/schemas/LocationOrAPMInfo"}},"additionalProperties":false},"RateResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"ListShipmentPrices":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentPrice"},"description":"List of list shipment prices, where item.PackageIndex = 0 represents a total cost for the entire shipment. and PackageIndex > 0 represents each package cost and are set on the PacakgePrices","nullable":true},"AccountShipmentPrices":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentPrice"},"description":"List of account shipment prices, where item.PackageIndex = 0 represents a total cost for the entire shipment. and PackageIndex > 0 represents each package cost and are set on the PacakgePrices","nullable":true}},"additionalProperties":false},"RateZone":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/RateZoneType"},"Code":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Origin":{"$ref":"#/components/schemas/ServicePoint"},"Destination":{"$ref":"#/components/schemas/ServicePoint"},"Notes":{"type":"string","nullable":true}},"additionalProperties":false},"RateZoneType":{"enum":["Distance","ServicePointsMapping"],"type":"string"},"References":{"type":"object","properties":{"Reference1":{"type":"string","description":"Reference 1","nullable":true},"Reference2":{"type":"string","description":"Reference 1","nullable":true},"Reference3":{"type":"string","description":"department on this ref","nullable":true},"PurchaseOrderNumber":{"type":"string","description":"PO Number","nullable":true},"ShipmentID":{"type":"string","description":"Shipment Id / Reference 3 from ship page","nullable":true},"InvoiceNumber":{"type":"string","description":"Invoice # / Reference 4 from ship page","nullable":true}},"additionalProperties":false,"description":"Can be used for a shipment or a package, or both (package level takes priority)"},"RegisterAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"RegisterDetail":{"type":"object","properties":{"Code":{"type":"string","description":"The Code of the detail, ex: locationId","nullable":true},"Value":{"type":"string","description":"The value of the detail, ex:  123 (for the location id)","nullable":true}},"additionalProperties":false},"RegisterRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"Account":{"$ref":"#/components/schemas/Account"},"Client":{"$ref":"#/components/schemas/Client"},"Location":{"$ref":"#/components/schemas/Location"},"Website":{"$ref":"#/components/schemas/Website"}},"additionalProperties":false,"description":"Register Request"},"RegisterResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"ContextId":{"type":"string","format":"uuid"},"CarrierDetails":{"type":"array","items":{"$ref":"#/components/schemas/RegisterDetail"},"description":"Details retuned by carrier after register - these will be sent an the accountinfo details","nullable":true}},"additionalProperties":false},"ScanLocation":{"type":"object","properties":{"Country":{"type":"string","description":"Contry Code or Name of the scan location","nullable":true},"Province":{"type":"string","description":"Country Province Code or Name of the scan location","nullable":true},"City":{"type":"string","description":"City name of the scan Location","nullable":true},"Name":{"type":"string","description":"Name of the scan location","nullable":true}},"additionalProperties":false,"description":"Scan Location"},"SelectListAccountDetails":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false},"SelectListCarrierOption":{"type":"object","properties":{"Name":{"type":"string","nullable":true},"Value":{"type":"string","nullable":true}},"additionalProperties":false},"ServicePoint":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/ServicePointType"},"Code":{"type":"string","nullable":true},"Name":{"type":"string","nullable":true},"Notes":{"type":"string","nullable":true}},"additionalProperties":false},"ServicePointType":{"enum":["PostalCodeRange","City","Country"],"type":"string"},"ShipAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true},"GetDocumentsAPI":{"type":"boolean"},"CarrierEmail":{"type":"string","nullable":true},"NoTrackingGenerationAbility":{"type":"boolean"},"GenerateTrackingNumberForEachShipmentPackage":{"type":"boolean"},"ReRateBeforeShip":{"type":"boolean"}},"additionalProperties":false},"ShipmentDocument":{"type":"object","properties":{"Type":{"$ref":"#/components/schemas/ShipmentDocumentType"},"DocumentBase64String":{"type":"string","description":"Document Base 64 String - the document in Base64String format","nullable":true},"Encoding":{"$ref":"#/components/schemas/ShippingDocumentEncodingType"}},"additionalProperties":false,"description":"Shippping Document"},"ShipmentDocumentType":{"enum":["AllShippingLabels","CommercialInvoice","BOL","CMR"],"type":"string","description":"Document Type"},"ShipmentForPickup":{"type":"object","properties":{"TrackingNumber":{"type":"string","description":"Master Tracking Number of the shipment","nullable":true},"ShipmentId":{"type":"string","description":"Shipment Id of the shipment","nullable":true},"ShipmentNumber":{"type":"string","description":"Shipment Number of the shipment (or Pro Number)","nullable":true}},"additionalProperties":false,"description":"Shipment for Pickup"},"ShipmentPrice":{"type":"object","properties":{"PackageIndex":{"type":"integer","description":"Zero represents a total cost for the entire shipment.","format":"int32"},"ServiceCode":{"type":"string","description":"The carrier service code for this price","nullable":true},"ServiceName":{"type":"string","description":"The carrier service code for this price","nullable":true},"RateQuoteNumber":{"type":"string","description":"Some carriers return a unique identifier for loging purposes","nullable":true},"PackagingCode":{"type":"string","description":"Carrier specific packaging code (can be null)","nullable":true},"RatedWeight":{"$ref":"#/components/schemas/Weight"},"Freight":{"$ref":"#/components/schemas/FreightCost"},"Fuel":{"$ref":"#/components/schemas/FuelCost"},"Surcharges":{"type":"array","items":{"$ref":"#/components/schemas/SurchargeCost"},"description":"All surcharges, except fuel.","nullable":true},"Taxes":{"type":"array","items":{"$ref":"#/components/schemas/TaxCost"},"description":"All government taxes.","nullable":true},"CustomsAndDuties":{"type":"array","items":{"$ref":"#/components/schemas/CustomsAndDutiesCost"},"description":"Usually applied for international shipping.","nullable":true},"Delivery":{"$ref":"#/components/schemas/Delivery"},"RateZone":{"$ref":"#/components/schemas/RateZone"},"CurrencyCode":{"type":"string","description":"Price Currency","nullable":true},"ExchangeRate":{"$ref":"#/components/schemas/CurrencyExchangeRate"},"ServiceInfo":{"type":"string","description":"Service Information","nullable":true},"Total":{"type":"number","description":"Total cost","format":"double","readOnly":true},"PackagesPrices":{"type":"array","items":{"$ref":"#/components/schemas/Price"},"description":"Packages prices","nullable":true},"MPSPricingType":{"$ref":"#/components/schemas/MPSPricingType"}},"additionalProperties":false,"description":"Shipment level price, that also has all the individual package prices"},"ShipmentPrices":{"type":"object","properties":{"ListShipmentPrice":{"$ref":"#/components/schemas/ShipmentPrice"},"AccountShipmentPrice":{"$ref":"#/components/schemas/ShipmentPrice"}},"additionalProperties":false,"description":"Ship Response Prices"},"ShipmentTrackingWebhook":{"type":"object","properties":{"Url":{"type":"string","description":"WebhooUrl","nullable":true}},"additionalProperties":false,"description":"Shipment Tracking Webhook Details"},"ShippedPackage":{"type":"object","properties":{"Weight":{"$ref":"#/components/schemas/Weight"},"Dimensions":{"$ref":"#/components/schemas/Dimensions"},"PackagingCode":{"type":"string","description":"Packageing Code","nullable":true},"DeclaredValue":{"$ref":"#/components/schemas/Money"},"References":{"$ref":"#/components/schemas/References"},"FreightInfo":{"$ref":"#/components/schemas/FreightInfo"},"PreAssignTrackingNumber":{"$ref":"#/components/schemas/PreAssignTrackingNumber"},"TrackingNumber":{"type":"string","description":"Package Tracking Number","nullable":true},"ShipmentId":{"type":"string","description":"Package Shipment Id","nullable":true},"PackageDocuments":{"type":"array","items":{"$ref":"#/components/schemas/PackageDocument"},"description":"Package Shipping Documents","nullable":true}},"additionalProperties":false,"description":"Shipped package info"},"ShippedPackagesInfo":{"type":"object","properties":{"Packages":{"type":"array","items":{"$ref":"#/components/schemas/ShippedPackage"},"description":"shipped packages list","nullable":true}},"additionalProperties":false,"description":"Shipped packages info"},"ShippingDocumentEncodingType":{"enum":["PDF","PNG","CSV","ZPL2"],"type":"string","description":"EncodingType"},"ShipRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"SourceOfOrder":{"type":"string","description":"(Optional) Source of the order","nullable":true},"OrderNumber":{"type":"string","description":"(Optional) Order number","nullable":true},"ServiceCode":{"type":"string","description":"(Optional) Carrier Service Code","nullable":true},"Sender":{"$ref":"#/components/schemas/Company"},"Recipient":{"$ref":"#/components/schemas/Company"},"PackagesInfo":{"$ref":"#/components/schemas/PackagesInfo"},"PickupDate":{"type":"string","description":"The date of the pickup (default is today)","format":"date-time"},"Billing":{"$ref":"#/components/schemas/BillingOptions"},"SpecialOptions":{"type":"array","items":{"$ref":"#/components/schemas/SpecialOption"},"description":"(Optional) Carrier Specific Special Options","nullable":true},"Contents":{"$ref":"#/components/schemas/Contents"},"PickupDetails":{"$ref":"#/components/schemas/PickupDetails"},"ShipToLocationOrAPM":{"type":"boolean","description":"(Optional) Specify if the request is to ship the order to an APM/lOCKER or a fixed location: carrier location or a retail location"},"ShipToLocationOrAPMInfo":{"$ref":"#/components/schemas/LocationOrAPMInfo"},"ShipFromLocationOrAPM":{"type":"boolean","description":"(Optional) Specify if the request is to ship the order from an APM/lOCKER or a fixed location: carrier location or a retail location"},"ShipFromLocationOrAPMInfo":{"$ref":"#/components/schemas/LocationOrAPMInfo"},"InternationalOptions":{"$ref":"#/components/schemas/InternationalOptions"},"LabelPrintPreferences":{"$ref":"#/components/schemas/LabelPrintPreferencesType"},"GroupCode":{"type":"string","description":"(Mandatory) Used to group shipments on a specific location and a shipping date","nullable":true},"SpecialInstructions":{"type":"string","description":"(Optional) Special Instruction / Delivery Instruction","nullable":true},"ShipmentInstructions":{"type":"string","description":"(Optional) Shipment Instruction","nullable":true},"ShipmentReferences":{"$ref":"#/components/schemas/References"},"TrackingWebhook":{"$ref":"#/components/schemas/ShipmentTrackingWebhook"}},"additionalProperties":false,"description":"Ship Request"},"ShipResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"ShipmentPrices":{"$ref":"#/components/schemas/ShipmentPrices"},"PackagesInfo":{"$ref":"#/components/schemas/ShippedPackagesInfo"},"ShipmentDocuments":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentDocument"},"description":"Array of Shipping Document other then the packages labels. only abvailable if the carrier has shipping documents generation","nullable":true},"CarrierCloseGroupCode":{"type":"string","description":"if is suplied by carrier it will overide the existing group code with the new one. this code is sent on the close transaction when the user close the shipments in 2ship.","nullable":true},"ShipmentNumber":{"type":"string","description":"Shipment Master Number / PRO Number (for freight carriers)","nullable":true},"OriginHubCode":{"type":"string","description":"Origin/Route Hub/Termial/Airport Code (if many separate them by by space \" \")","nullable":true},"DestinationHubCode":{"type":"string","description":"Destination/Delivery Hub/Terminal/Airport Code (if many separate them by space \" \")","nullable":true}},"additionalProperties":false,"description":"Ship Response"},"SpecialOption":{"type":"object","properties":{"Code":{"type":"string","description":"Special Option Code","nullable":true},"OptionDetails":{"type":"array","items":{"$ref":"#/components/schemas/OptionDetail"},"description":"Special options Details. on this field should we put all the other inf of the option. \r\nHere you will receive the fields that you setup on carrier signup.\r\nfor ex: Special option is Cash on Delivery, will be set diferent fields like amount to be collected ( for ex Code  = \"amount\" and on the Value = \"100\"), on other field can be the currency of that amount (ex Code = \"currency\" and value = \"USD\")","nullable":true},"PackageIndex":{"type":"integer","description":"0 means all packages, 1 mean first package, 2 second package - etc","format":"int32"}},"additionalProperties":false,"description":"Carrier Special Option"},"SurchargeCost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"},"AffectsFuel":{"type":"boolean"}},"additionalProperties":false,"description":"Transportation special service surcharge or extra-cost.\r\nA surcharge affects the fuel when the fuel % is also applied to this amount (in addition to the freight)."},"TaxCost":{"type":"object","properties":{"Name":{"type":"string","description":"The name of this cost.","nullable":true},"Amount":{"type":"number","description":"The currency amount for this cost (can be zero or negative).","format":"double"},"Type":{"$ref":"#/components/schemas/PercentageCalculationType"},"BaseCost":{"$ref":"#/components/schemas/Cost"},"Percentage":{"type":"number","description":"Usually between 0 and 1, for example a 35% discount should be set as 0.35, and a 200% markup must be set as 2.0","format":"double"}},"additionalProperties":false},"TermsOfSaleType":{"enum":["ExWorks","DeliveredDutyUnpaid","DeliveredDutyPaid","FreeCarrier","FreeOnBoard","CostInsuranceAndFreight","FreightOrCarriage","CarriagePaidTo","CostAndFreight","FreeAlongSideShip","DeliveryAtTerminal","DeliveryAtPlace","CarriageInsurancePaidTo"],"type":"string","description":"International Terms of sales (Code 195)"},"TrackingAPI":{"type":"object","properties":{"RemoteUrl":{"type":"string","nullable":true}},"additionalProperties":false},"TrackingEvents":{"type":"object","properties":{"ScanDate":{"type":"string","description":"ScanDate","format":"date-time"},"Status":{"$ref":"#/components/schemas/TrackingStatusType"},"Description":{"type":"string","description":"Scan Description","nullable":true},"ScanLocationInfo":{"$ref":"#/components/schemas/ScanLocation"}},"additionalProperties":false,"description":"Tracking Events"},"TrackingRequest":{"type":"object","properties":{"Id":{"type":"string","description":"Id of the request","format":"uuid"},"Language":{"$ref":"#/components/schemas/LanguageType"},"ContextId":{"type":"string","description":"(Required) to identify the context of the carrier - related to this id is the client, account, location and website","format":"uuid"},"AccountInfo":{"$ref":"#/components/schemas/AccountInfo"},"TrackingNumber":{"type":"string","description":"Tracking Number","nullable":true},"ShipmentId":{"type":"string","description":"Shipment Id","nullable":true},"ShipmentNumber":{"type":"string","description":"Shipment Master Number / PRO Number (for freight carriers)","nullable":true},"GetOnlyCODRefundStatus":{"type":"boolean","description":"Response should retun only if the cod was refunded or not"},"GetOnlyPODDocuments":{"type":"boolean","description":"Response should retun only pod and other dcouments"}},"additionalProperties":false,"description":"Tracking Request"},"TrackingResponse":{"type":"object","properties":{"RequestId":{"type":"string","description":"The Id of the incomming request","format":"uuid"},"Success":{"type":"boolean","description":"Specify if the request was success"},"Warnings":{"type":"array","items":{"type":"string"},"description":"The list of warnings","nullable":true},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true},"TrackingStatus":{"$ref":"#/components/schemas/TrackingStatusType"},"TrackingStatusDescription":{"type":"string","description":"The status Description of your shipment","nullable":true},"EstimatedDeliveryDate":{"type":"string","description":"Estimated delivery date if not delivered alrready","format":"date-time","nullable":true},"DeliveryDate":{"type":"string","description":"Delivery date, if the shipment was delivered","format":"date-time","nullable":true},"SignatureBase64String":{"type":"string","description":"if is not empty it contains the base64 string of the signature image (POD)","nullable":true},"SignedBy":{"type":"string","description":"Signed By","nullable":true},"Events":{"type":"array","items":{"$ref":"#/components/schemas/TrackingEvents"},"description":"List Of Tracking Events","nullable":true},"OtherDocuments":{"type":"array","items":{"$ref":"#/components/schemas/OtherDocument"},"description":"List of other documents","nullable":true}},"additionalProperties":false,"description":"Tracking Response"},"TrackingStatusType":{"enum":["PickedUp","InTransit","DeliveryException","ReturnToShipper","Delivered","Canceled"],"type":"string","description":""},"TrackingWebhookResponse":{"type":"object","properties":{"Success":{"type":"boolean","description":"Specify if the request was success"},"Messages":{"type":"array","items":{"$ref":"#/components/schemas/ErrorMessage"},"description":"the list of Error Messages if the request was not success","nullable":true}},"additionalProperties":false,"description":"Tracking Response"},"TwoShipPackagingCodeType":{"enum":["Customer","Envelope","Pak","Box","Tube","_10_Kg_Box","_25_Kg_Box","Bundle","Euro_Pallet","Pallet","Reel","Crate","Roll","Chep_Pallet","Loscam_Pallet"],"type":"string"},"Website":{"type":"object","properties":{"Id":{"type":"integer","description":"Webiste ID","format":"int32"},"LanguageCode":{"type":"string","description":"Two letter ISO 639-1 code, for ex EN or FR (defaults to EN)","nullable":true},"Url":{"type":"string","description":"Website URL","nullable":true}},"additionalProperties":false,"description":"2Ship Website"},"Weight":{"type":"object","properties":{"Value":{"type":"number","description":"Weight Value","format":"double"},"Type":{"$ref":"#/components/schemas/WeightType"}},"additionalProperties":false},"WeightType":{"enum":["Pounds","Kilograms"],"type":"string","description":"Weight Type"}},"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Enter your Api Key below:","name":"Authorization","in":"header"}}},"security":[{"ApiKey":[]}]}