Move Flow

This document describes the endpoints required to manage both the billing and delivery address changes a.k.a. Moves.

Integration

1. Call Get Availability endpoint providing subscription id and allowDigitalSubscriptions in true to check if the change address is allowed to the subscriber. If so, it will return the dates to fill the calendar

2. You will call Get Moves by Subscription to retrieve the pending moves for a subscription to be displayed in a table. In case there is some pending move, you can Update Move or Cancel Move.

3. Calling Get Subscription By Id you will be able to retrieve Subscriptions data (like Products, Service Types, Addresses). But, you can just call Get Address Information by Subscription to retrieve the addresses.

4. Get States and Get Locations are useful to populate forms. The first one returns a list of states for a country code. The other, providing a postal code, it will return the city and the state

5. As said in point before, calling Get Availability endpoint you will get the dates to display the stop calendar. If the flow involves Change Delivery Address, once you select the stop date you will be required to select a resume delivery date. For this, you can use the same resume dates provided with the previous call or you can call it again passing Stop Date as parameter to get the refreshed dates.

6. To Process a new move, select the proper stop date (and resume date if applicable) and a valid address is required. The same for updating a pending move. To cancel a move, only a confirmation is required.

Header parameters

API needs to receive five header parameters to operate:

• X-MediaGroupCode, X-Clientcode, X-PaperCode: Three parameters used by the API to identify the tenant to use

• X-SourceSystem: String used to identify who the consumer is

• Authorization: JSON web token used for security purposes

Get Subscription by Id

GET /Subscriptions/{subscriptionId}

Retrieves a subscription

Path Parameters

Name	Type	Description
SubscriptionId*	Integer	Unique identifier of the Subscription in Naviga System.

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK Subscription successfully retrieved

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Subscription": {
			"SubscriptionId": 0,
			"ExternalSubscriptionId": "string",
			"SubscriberId": 0,
			"ExternalSubscriberId": "string",
			"MerchantSubscriberId": "string",
			"AccountNumber": "string",
			"FirstName": "string",
			"LastName": "string",
			"FullName": "string",
			"Email": "string",
			"BillingPlanId": 0,
			"OfferId": 0,
			"PromotionId": 0,
			"PremiumGiftId": 0,
			"Phone": "string",
			"CompanyName": "string",
			"ExternalSubscriptionBillingPlanId": "string",
			"PaymentMethodId": 0,
			"ExternalSubscriptionPaymentMethodId": "string",
			"PaymentMethod": {
				"PaymentMethodId": 0,
				"ExternalPaymentMethodId": "string",
				"HolderName": "string",
				"Active": true,
				"PaymentMethodType": "string",
				"FirstName": "string",
				"LastName": "string",
				"CompanyName": "string",
				"Phone": "string",
				"BillingAddress": {
					"AddressId": 0,
					"ExternalAddressId": "string",
					"FullName": "string",
					"FirstName": "string",
					"LastName": "string",
					"Company": "string",
					"Address": "string",
					"Address2": "string",
					"HouseNumber": "string",
					"StreetName": "string",
					"StreetSuffix": "string",
					"PreDirect": "     ",
					"PostDirect": "string",
					"AptNumber": "string",
					"AptUnit": " ",
					"UnitType": "string",
					"District": "string",
					"City": "YUBA CITY",
					"CityCode": "string",
					"State": "string",
					"ZipCode": "string",
					"ZipCode4": "string",
					"DPVCode": "string",
					"SuiteStatus": "string",
					"DeliveryPointCheckDigit": "string",
					"DPVFootnotes": "string",
					"DeliveryPointCode": "string",
					"CountyFips": "string",
					"Msa": "string",
					"PakHash": "string",
					"ParsedAddressKey": "string",
					"StandardizationError": "string",
					"StandardizationResult": "string",
					"Latitude": "string",
					"Longitude": "string",
					"CensusBlock": "string",
					"CensusTract": "string",
					"GeoCoderResult": "string",
					"CarrierRoute": "string",
					"CountryCode": "string",
					"Country": "string",
					"LockBox": "string",
					"Phone": "string",
					"Route": "string",
					"Title": "string",
					"AddressTypeCode": "string",
					"AddressType": "string",
					"DependentLocality": "string",
					"CountyName": "string"
				}
			},
			"DeliveryAddress": {
				"AddressId": 0,
				"ExternalAddressId": "string",
				"FullName": "string",
				"FirstName": "string",
				"LastName": "string",
				"Company": "string",
				"Address": "string",
				"Address2": "string",
				"HouseNumber": "string",
				"StreetName": "string",
				"StreetSuffix": "string",
				"PreDirect": "string",
				"PostDirect": "string",
				"AptNumber": "string",
				"AptUnit": " ",
				"UnitType": "string",
				"District": "string",
				"City": "string",
				"CityCode": "string",
				"State": "string",
				"ZipCode": "string",
				"ZipCode4": "string",
				"DPVCode": "string",
				"SuiteStatus": "string",
				"DeliveryPointCheckDigit": "string",
				"DPVFootnotes": "string",
				"DeliveryPointCode": "string",
				"CountyFips": "string",
				"Msa": "string",
				"PakHash": "string",
				"ParsedAddressKey": "string",
				"StandardizationError": "string",
				"StandardizationResult": "string",
				"Latitude": "string",
				"Longitude": "string",
				"CensusBlock": "string",
				"CensusTract": "string",
				"GeoCoderResult": "string",
				"CarrierRoute": "string",
				"CountryCode": "string",
				"Country": "string",
				"LockBox": "string",
				"Phone": "string",
				"Route": "string",
				"Title": "string",
				"AddressTypeCode": "string",
				"AddressType": "string",
				"DependentLocality": "string",
				"CountyName": "string"
			},
			"BillingAddress": {
				"AddressId": 0,
				"ExternalAddressId": "string",
				"FullName": "string",
				"FirstName": "string",
				"LastName": "string",
				"Company": "string",
				"Address": "string",
				"Address2": "string",
				"HouseNumber": "string",
				"StreetName": "string",
				"StreetSuffix": "string",
				"PreDirect": "     ",
				"PostDirect": "string",
				"AptNumber": "string",
				"AptUnit": " ",
				"UnitType": "string",
				"District": "string",
				"City": "string",
				"CityCode": "string",
				"State": "string",
				"ZipCode": "string",
				"ZipCode4": "string",
				"DPVCode": "string",
				"SuiteStatus": "string",
				"DeliveryPointCheckDigit": "string",
				"DPVFootnotes": "string",
				"DeliveryPointCode": "string",
				"CountyFips": "string",
				"Msa": "string",
				"PakHash": "string",
				"ParsedAddressKey": "string",
				"StandardizationError": "string",
				"StandardizationResult": "string",
				"Latitude": "string",
				"Longitude": "string",
				"CensusBlock": "string",
				"CensusTract": "string",
				"GeoCoderResult": "string",
				"CarrierRoute": "string",
				"CountryCode": "string",
				"Country": "string",
				"LockBox": "string",
				"Phone": "string",
				"Route": "string",
				"Title": "string",
				"AddressTypeCode": "string",
				"AddressType": "string",
				"DependentLocality": "string",
				"CountyName": "string"
			},
			"MerchantId": "string",
			"Active": true,
			"HasPrintProducts": true,
			"HasDigitalProducts": true,
			"HasGoogleProducts": false,
			"Status": "L",
			"StatusDescription": "Active",
			"StartDate": "1998-06-04T00:00:00",
			"StopDate": "string",
			"ExpirationDate": "2020-07-31T00:00:00",
			"NewspaperId": 3,
			"NewspaperName": "string",
			"PaperCode": "string",
			"Products": [
				{
					"SubscriptionProductId": 0,
					"ExternalSubscriptionProductId": "string",
					"SubscriptionId": 10,
					"ProductId": 0,
					"StartDate": "1998-06-04T00:00:00",
					"StopDate": "string",
					"Product": {
						"ProductId": 0,
						"ExternalProductId": "string",
						"ExternalMerchantId": "string",
						"Name": "string",
						"Price": 0,
						"Currency": "string",
						"Active": true,
						"PaperCode": "string",
						"NewspaperId": 3,
						"ServiceTypeId": 1,
						"NewspaperBillingCode": 3,
						"IsPrint": true,
						"IsDigital": true,
						"ServiceType": {
							"ServiceTypeId": 1,
							"Name": "string",
							"Description": "string",
							"Sequence": 0,
							"Days": 0,
							"DeliveryMap": "string",
							"Code": "string",
							"ProductCode": "string",
							"Active": true,
							"eEditionAccess": true,
							"AllowPreviousSunday": false,
							"ServiceDays": [
								{
									"Day": 0,
									"DayName": "string",
									"PrintAllowed": true,
									"DigitalAllowed": true
								}
							]
						},
						"Discount": "string",
						"Description": "string",
						"IsAddOn": false,
						"DeliveryMethod": "string",
						"OneTimeCharge": false,
						"RegularRate": "string",
						"CircSystemId": 3,
						"BusinessName": "string",
						"Code": "string",
						"RenewalProductId": "string",
						"RenewalProduct": "string",
						"GoogleProducts": [],
						"IsBase": true
					},
					"Amount": 0,
					"Currency": "string",
					"CampaignId": "string",
					"CampaignCode": "string",
					"IsAutoRenewal": false,
					"Cycles": 0,
					"Copies": 1,
					"RemainingCycles": 0,
					"MatherPrice": "string",
					"MatherDate": "string",
					"MatherAlternativePrices": []
				}
			],
			"FutureProducts": [],
			"OldProducts": [],
			"NewStartQueueId": 0,
			"CirculationSystemAccountId": "string",
			"DateCreated": "string",
			"ProcessingStatus": "string",
			"TransactionType": "string",
			"RateCode": "string",
			"HouseholdSubscriptionLevel": 1,
			"UpgradeSmartOfferSegment": "string",
			"DowngradeSmartOfferSegment": "string",
			"SubscriptionType": "string",
			"Sub3Code": "string",
			"PromoCert": "string",
			"PromoCredit": "string",
			"PromoSource": "string",
			"PromoSubSource": "string",
			"StartSource": "string",
			"StartReason": "string",
			"StopSource": "string",
			"StopReason": "string",
			"IsEZPay": false,
			"HaseBill": false,
			"IsTerm": "string",
			"IsTrial": false,
			"PaymentFlag": "string",
			"DailyRate": 0,
			"DeliveryMethod": "string",
			"BillingMethod": "string",
			"WeekDayCredit": "string",
			"SundayCredit": "string",
			"IsCompSubscription": "string",
			"IsMailSubscription": false,
			"DailyRateWithTaxes": 0,
			"UpgradeSubscriptionPromotionId": "string",
			"DowngradeSubscriptionPromotionId": "string",
			"UpgradeProductsPromotionId": "string",
			"SubscriptionDescription": "string",
			"BaseProduct": {
				"ProductId": 0,
				"ExternalProductId": "string",
				"ExternalMerchantId": "string",
				"Name": "string",
				"Price": 0,
				"Currency": "string",
				"Active": true,
				"PaperCode": "string",
				"NewspaperId": 0,
				"ServiceTypeId": 0,
				"NewspaperBillingCode": 0,
				"IsPrint": true,
				"IsDigital": true,
				"ServiceType": {
					"ServiceTypeId": 0,
					"Name": "string",
					"Description": "string",
					"Sequence": 0,
					"Days": 0,
					"DeliveryMap": "string",
					"Code": "string",
					"ProductCode": "string",
					"Active": true,
					"eEditionAccess": true,
					"AllowPreviousSunday": false,
					"ServiceDays": [
						{
							"Day": 0,
							"DayName": "Sunday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 1,
							"DayName": "Monday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 2,
							"DayName": "Tuesday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 3,
							"DayName": "Wednesday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 4,
							"DayName": "Thursday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 5,
							"DayName": "Friday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						},
						{
							"Day": 6,
							"DayName": "Saturday",
							"PrintAllowed": true,
							"DigitalAllowed": true
						}
					]
				},
				"Discount": "string",
				"Description": "string",
				"IsAddOn": false,
				"DeliveryMethod": "string",
				"OneTimeCharge": false,
				"RegularRate": "string",
				"CircSystemId": 0,
				"BusinessName": "string",
				"Code": "string",
				"RenewalProductId": "string",
				"RenewalProduct": "string",
				"GoogleProducts": [],
				"IsBase": true
			},
			"DeliveryStartDate": "string",
			"EffectiveStartDate": "string",
			"PermanentStopDate": "string",
			"CurrentBalance": 0,
			"DatePaidThru": "2020-07-31T00:00:00",
			"CurrentRate": 0,
			"ExpirationDateOverride": "string",
			"GraceDays": "string",
			"SubscriptionStopReason": "string",
			"SubscriptionSmartOffers": [
				{
					"SmartOfferId": 0,
					"SmartOfferCode": "string",
					"SmartOfferType": "string",
					"SmartOfferSource": "string"
				},
				{
					"SmartOfferId": 0,
					"SmartOfferCode": "string",
					"SmartOfferType": "string",
					"SmartOfferSource": "string"
				}
			],
			"CustomerSince": "string",
			"Market": "string",
			"SubscriberType": "string",
			"BillingState": "string",
			"eBillEmail": "string",
			"eBillEmailType": "string",
			"AutobillStatus": "string",
			"WeeklyRate": "string",
			"RegistrationCount": "string",
			"IsSeasonal": false,
			"IsExternal": false,
			"Currency": "string",
			"CurrencySymbol": "string",
			"CurrencyCulture": "string",
			"CircSystemId": 3,
			"CircSystemCode": "string",
			"CircSystemName": "string",
			"SubscriptionEmail": "string",
			"ProductChange": "string",
			"Kind": "string",
			"Coupon": "string"
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK The subscription id is invalid. It cannot be null or 0

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription id is invalid. It cannot be null or 0",
         "Code":"Subscriptions16",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any subscription.",
         "Code":"Subscriptions02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{
    "error":"Authorization is missing."
}

400: Bad Request X-SourceSystem is missing

{
    "error":"X-SourceSystem is missing."
}

401: Unauthorized Invalid Source System

{
    "error":"Invalid Source System."
}

401: Unauthorized Invalid authorization

{
    "error":"Invalid authorization."
}

500: Internal Server Error Something went wrong. Please try again later

{
    {"error":"Something went wrong. Please try again later."}
}

Get Address Information by Subscription

GET /Address/{SubscriptionId}

Retrieves both billing and delivery information for a specific subscription

Path Parameters

Name	Type	Description
SubscriptionId*	Integer	Unique identifier of the Subscription in Naviga System

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK Addresses successfully returned

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"SubscriptionId": 0,
		"ExternalSubscriptionId": "string",
		"ExternalSubscriberId": "string",
		"AccountNumber": "string",
		"LastName": "string",
		"SubscriptionStatus": "string",
		"DeliveryAddress": {
			"AddressId": 0,
			"ExternalAddressId": "string",
			"Address": "string",
			"AptUnit": "string",
			"City": "string",
			"State": "string",
			"PostalCode": "string",
			"Zip4": "string",
			"Country": "string",
			"Name": "string",
			"Phone": "string",
			"FirstName": "string",
			"LastName": "string",
			"Street": "string",
			"StreetSuffix": "string",
			"HouseNumber": "string",
			"StreetName": "string",
			"UnitNumber": "string",
			"UnitType": "string",
			"County": "string",
			"PreDirect": "string",
			"PostDirect": "string",
			"PakHash": "string"
		},
		"BillingAddress": {
			"AddressId": 0,
			"ExternalAddressId": "string",
			"Address": "string",
			"AptUnit": "string",
			"City": "string",
			"State": "string",
			"PostalCode": "string",
			"Zip4": "string",
			"Country": "string",
			"Name": "string",
			"Phone": "string",
			"FirstName": "string",
			"LastName": "string",
			"Street": "string",
			"StreetSuffix": "string",
			"HouseNumber": "string",
			"StreetName": "string",
			"UnitNumber": "string",
			"UnitType": "string",
			"County": "string",
			"PreDirect": "string",
			"PostDirect": "string",
			"PakHash": "string"
		},
		"ChangeAddressAllowed":true,
		"ChangeDeliveryAddressAllowed":true,
		"ChangeBillingAddressAllowed":true,
		"AllowanceReason": {
			"Message": "string",
			"Code": "string",
			"Type": {
				"Id": 0,
				"Code": "string"
			}
		},
		"MerchantBaseProductId": "string",
		"ProductCode": "string"
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid Input

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find address for subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find address for subscription.",
         "Code":"Address10",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{
    "error":"Authorization is missing."
}

400: Bad Request X-SourceSystem is missing

{
 "error":"X-SourceSystem is missing."	
}

401: Unauthorized Invalid Source System

{
  "error":"Invalid Source System."
}

401: Unauthorized Invalid authorization

{
"error":"Invalid authorization."	
}

500: Internal Server Error Something went wrong. Please try again later

{
    "Something went wrong. Please try again later."
}

Get Moves by Subscription

GET /Moves?SubscriptionId={subscriptionId}

Retrieves the moves for a subscription

Query Parameters

Name	Type	Description
SubscriptionId*	String	Unique identifier of the Subscription in Naviga System

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK List of moves successfully returned for the subscription

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Moves": [
			{
				"MoveId": 0,
				"SubscriptionId": 0,
				"MoveType": {
					"MoveTypeId": 0,
					"Name": "string",
					"Description": "string",
					"Active":true
				},
				"MoveSubscriptionProducts": [
					{
						"MoveSubscriptionProductId": 0,
						"MoveId": 0,
						"SubscriptionProductId": 0,
						"DeliveryStopDate":"2022-04-26T13:40:51.494Z",
						"EffectiveStopDate":"2022-04-26T13:40:51.494Z",
						"DeliveryResumeDate":"2022-04-26T13:40:51.494Z",
						"EffectiveResumeDate":"2022-04-26T13:40:51.494Z"
					}
				],
				"OldAddressId": 0,
				"OldAddress": {
					"Address": "string",
					"HouseNumber": "string",
					"StreetName": "string",
					"StreetSuffix": "string",
					"PreDirect": "string",
					"PostDirect": "string",
					"AptNumber": "string",
					"AptUnit": "string",
					"UnitType": "string",
					"District": "string",
					"City": "string",
					"State": "string",
					"ZipCode": "string",
					"ZipCode4": "string",
					"DPVCode": "string",
					"SuiteStatus": "string",
					"Suite": "string",
					"DeliveryPointCheckDigit": "string",
					"DPVFootnotes": "string",
					"DeliveryPointCode": "string",
					"CountyFips": "string",
					"CountyName": "string",
					"Country": "string",
					"LockBox": "string",
					"RouteService": "string",
					"Msa": "string",
					"CarrierRoute": "string",
					"ParsedAddressKey": "string",
					"PakHash": "string",
					"StandardizationError": "string",
					"StandardizationErrorMessage": "string",
					"StandardizationResult": "string",
					"Latitude": "string",
					"Longitude": "string",
					"CensusBlock": "string",
					"CensusTract": "string",
					"GeoCoderResult": "string",
					"ParsedGarbage": "string",
					"AddressTypeCode": "string",
					"AddressType": "string"
				},
				"NewAddressId": 0,
				"NewAddress": {
					"Address": "string",
					"HouseNumber": "string",
					"StreetName": "string",
					"StreetSuffix": "string",
					"PreDirect": "string",
					"PostDirect": "string",
					"AptNumber": "string",
					"AptUnit": "string",
					"UnitType": "string",
					"District": "string",
					"City": "string",
					"State": "string",
					"ZipCode": "string",
					"ZipCode4": "string",
					"DPVCode": "string",
					"SuiteStatus": "string",
					"Suite": "string",
					"DeliveryPointCheckDigit": "string",
					"DPVFootnotes": "string",
					"DeliveryPointCode": "string",
					"CountyFips": "string",
					"CountyName": "string",
					"Country": "string",
					"LockBox": "string",
					"RouteService": "string",
					"Msa": "string",
					"CarrierRoute": "string",
					"ParsedAddressKey": "string",
					"PakHash": "string",
					"StandardizationError": "string",
					"StandardizationErrorMessage": "string",
					"StandardizationResult": "string",
					"Latitude": "string",
					"Longitude": "string",
					"CensusBlock": "string",
					"CensusTract": "string",
					"GeoCoderResult": "string",
					"ParsedGarbage": "string",
					"AddressTypeCode": "string",
					"AddressType": "string"
				},
				"StopDate":"2022-04-26T13:40:51.494Z",
				"ResumeDate":"2022-04-26T13:40:51.494Z",
				"Active":true
			}
		]
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid Input

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing Subscription Id

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing Subscription Id.",
         "Code":"Address20",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

400: Bad Request X-SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

401: Unauthorized Invalid authorization

{"error":"Invalid authorization."} 		

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Get Move by Id

GET /Moves/{MoveId}

Retrieves a specific move

Path Parameters

Name	Type	Description
MoveId*	Integer	Unique identifier of a move.

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK The Move is successfully retrieved

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Move": {
			"MoveId": 0,
			"SubscriptionId": 0,
			"MoveType": {
				"MoveTypeId": 0,
				"Name": "string",
				"Description": "string",
				"Active":true
			},
			"MoveSubscriptionProducts": [
				{
					"MoveSubscriptionProductId": 0,
					"MoveId": 0,
					"SubscriptionProductId": 0,
					"DeliveryStopDate":"2022-04-26T13:40:51.494Z",
					"EffectiveStopDate":"2022-04-26T13:40:51.494Z",
					"DeliveryResumeDate":"2022-04-26T13:40:51.494Z",
					"EffectiveResumeDate":"2022-04-26T13:40:51.494Z"
				}
			],
			"OldAddressId": 0,
			"OldAddress": {
				"Address": "string",
				"HouseNumber": "string",
				"StreetName": "string",
				"StreetSuffix": "string",
				"PreDirect": "string",
				"PostDirect": "string",
				"AptNumber": "string",
				"AptUnit": "string",
				"UnitType": "string",
				"District": "string",
				"City": "string",
				"State": "string",
				"ZipCode": "string",
				"ZipCode4": "string",
				"DPVCode": "string",
				"SuiteStatus": "string",
				"Suite": "string",
				"DeliveryPointCheckDigit": "string",
				"DPVFootnotes": "string",
				"DeliveryPointCode": "string",
				"CountyFips": "string",
				"CountyName": "string",
				"Country": "string",
				"LockBox": "string",
				"RouteService": "string",
				"Msa": "string",
				"CarrierRoute": "string",
				"ParsedAddressKey": "string",
				"PakHash": "string",
				"StandardizationError": "string",
				"StandardizationErrorMessage": "string",
				"StandardizationResult": "string",
				"Latitude": "string",
				"Longitude": "string",
				"CensusBlock": "string",
				"CensusTract": "string",
				"GeoCoderResult": "string",
				"ParsedGarbage": "string",
				"AddressTypeCode": "string",
				"AddressType": "string"
			},
			"NewAddressId": 0,
			"NewAddress": {
				"Address": "string",
				"HouseNumber": "string",
				"StreetName": "string",
				"StreetSuffix": "string",
				"PreDirect": "string",
				"PostDirect": "string",
				"AptNumber": "string",
				"AptUnit": "string",
				"UnitType": "string",
				"District": "string",
				"City": "string",
				"State": "string",
				"ZipCode": "string",
				"ZipCode4": "string",
				"DPVCode": "string",
				"SuiteStatus": "string",
				"Suite": "string",
				"DeliveryPointCheckDigit": "string",
				"DPVFootnotes": "string",
				"DeliveryPointCode": "string",
				"CountyFips": "string",
				"CountyName": "string",
				"Country": "string",
				"LockBox": "string",
				"RouteService": "string",
				"Msa": "string",
				"CarrierRoute": "string",
				"ParsedAddressKey": "string",
				"PakHash": "string",
				"StandardizationError": "string",
				"StandardizationErrorMessage": "string",
				"StandardizationResult": "string",
				"Latitude": "string",
				"Longitude": "string",
				"CensusBlock": "string",
				"CensusTract": "string",
				"GeoCoderResult": "string",
				"ParsedGarbage": "string",
				"AddressTypeCode": "string",
				"AddressType": "string"
			},
			"StopDate":"2022-04-26T13:40:51.494Z",
			"ResumeDate":"2022-04-26T13:40:51.494Z",
			"Active":true
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid or missing move id

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing move id.",
         "Code":"Address39",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any move

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any move.",
         "Code":"Address40",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

400: Bad Request X-SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

401: Unauthorized Invalid authorization

{"error":"Invalid authorization."} 		

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Get States

GET /States/{CountryCode}

Retrieves a list of states for a specific country code

Path Parameters

Name	Type	Description
CountryCode*	String	Short code that represents a country.

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK List of the states returned successfully

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"States": [
			{
				"Code": "string",
				"Name": "string"
			}
		]
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid Input

{
   "Code":400,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find states for the given country code

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find states for the given country code.",
         "Code":"Address16",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

400: Bad Request X-SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

401: Unauthorized Invalid authorization.

{"error":"Invalid authorization."} 		

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Get Locations

GET /Locations/{ZipCode}

Retrieves City and State for a specific postal code

Path Parameters

Name	Type	Description
ZipCode*	String	Represents a postal code

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK City and State successfully returned

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Location": {
			"City":"string",
			"State":"string"
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid Input

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any location for the given zip code

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any location for the given zip code.",
         "Code":"Address15",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

400: Bad Request SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

401: Unauthorized Invalid authorization

{"error":"Invalid authorization."} 		

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Get Availability

GET /TemporaryStops/Subscriptions/[subscriptionId]/Availability?stopDate{stopDate}&allowDigitalSubscriptions=true

Checks and returns the availability to do a move for a subscription. It will provide the dates allowed to change both billing and delivery address. For Change Delivery Address, call this endpoint with stop date

Path Parameters

Name	Type	Description
SubscriptionID*	String	Unique identifier of the Subscription in Naviga System

Query Parameters

Name	Type	Description
StopDate	Datetime	Represents the date when the delivery to the current address will be stopped. If provided it will retrieve the valid dates to restart the delivery
AllowDigitalSubscriptions*	Boolean	Indicates if the Digital Only subscriptions should be considered when checking the availability. This must be True

Headers

Name	Type	Description
Authorization*	String
X-SourceCode*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-Papercode*	String

200: OK Move is available

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Availability":{
			"Available":true,
			"MaxResumeDate":"2022-04-26T13:40:51.494Z",
			"MaxStopDate":"2022-04-26T13:40:51.494Z",
			"MinResumeDate":"2022-04-26T13:40:51.494Z",
			"MinStopDate":"2022-04-26T13:40:51.494Z"
		      }
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Moves are not available for Trial and Complimentary subscriptions

{
   "Code":200,
   "Errors":[
      {
         "Message":"Trial subscriptions cannot access to this page.",
         "Code":"TemporaryStop74",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription does not have print products

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription does not have print products",
         "Code":"TemporaryStop05",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK There are no newspaper settings available for the selected publication

{
   "Code":200,
   "Errors":[
      {
         "Message":"There are no newspaper settings available for the selected publication.",
         "Code":"TemporaryStop52",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any subscription.",
         "Code":"Subscriptions02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription id is invalid. It cannot be null or 0

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription id is invalid. It cannot be null or 0",
         "Code":"Subscriptions16",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request The subscription does not have active products

{
   "Code":400,
   "Errors":[
      {
         "Message":"The subscription does not have active products.",
         "Code":"Gateway08",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Operation is not allowed because subscription has a permanent stop scheduled at a future date

{
   "Code":400,
   "Errors":[
      {
         "Message":"Operation is not allowed because subscription has a permanent stop scheduled at a future date.",
         "Code":"Gateway17",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

401: Unauthorized Invalid authorization

{"error":"Invalid authorization."} 		

500: Internal Server Error

{
   "Code":500,
   "Errors":[],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

400: Bad Request X-SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Add Move

POST /Moves

Create a new move for a subscription. It could be for both billing and delivery addresses

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

Request Body

Name	Type	Description
SubscriptionId*	Integer	Unique identifier of the Subscription in Naviga System
AddressChangeType*	Integer	Represents the type of movement
ValidateAddress*	Boolean	Indicate if address should be validated
StopDate*	Datetime	Date in UTC when the address is no longer valid
ResumeDate	Datetimr	Date in UTC when the delivery should be restarted. Required only for delivery address change
BillingAddress.Address*	String	New billing address
BillingAddress.City*	String	New billing city
BillingAddress.State*	String	New billing state
BillingAddress.PostalCodee*	String	New billing postal code
BillingAddress.FirstName*	String	New billing first name
BillingAddress.LastName*	String	New billing last name
BillingAddress.Phone*	String	New billing address phone
DeliveryAddress.Address*	String	New delivery address
DeliveryAddress.City*	String	New delivery city
DeliveryAddress.State*	String	New delivery state
DeliveryAddress.PostalCodee*	String	New delivery postal code
DeliveryAddress.FirstName*	String	New delivery first name
DeliveryAddress.LastName*	String	New delivery last name
DeliveryAddress.Phone*	String	New delivery phone

200: OK Could not process Delivery Check Event

{
   "Code":200,
   "Errors":[
      {
         "Message":" Could not process Delivery Check Event.",
         "Code":"Address14",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request

{
    // Response
}

200: OK Could not create Delivery Check Event

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not create Delivery Check Event.",
         "Code":"Address13",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing products

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing products.",
         "Code":"Address24",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Address standardization failed

{
   "Code":200,
   "Errors":[
      {
         "Message":"Address standardization failed.",
         "Code":"Address02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid Input

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription has a pending delivery address move. Can't submit another one

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription has a pending delivery address move. Can't submit another one.",
         "Code":"Address46",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find address for subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find address for subscription.",
         "Code":"Address10",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The delivery address is not routable

{
   "Code":200,
   "Errors":[
      {
         "Message":"The delivery address is not routable.",
         "Code":"Address11",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription has a pending billing address move. Can't submit another one

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription has a pending billing address move. Can't submit another one.",
         "Code":"Address47",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing address information. Address, City, State and Postal Code are required

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing address information. Address, City, State and Postal Code are required.",
         "Code":"Address19",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

401: Unauthorized X-SourceSystem is missing

{"error":"X-SourceSystem is missing."} 	

200: OK Move(s) successfully added

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Done":true,
		"DeliveryAddressStatus": {
			"Status": 0,
			"StatusDescription": "string",
			"MoveId": 0
		},
		"BillingAddressStatus": {
			"Status": 0,
			"StatusDescription": "string",
			"MoveId": 0
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

500: Internal Server Error

{
   "Code":500,
   "Errors":[],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

401: Unauthorized Invalid Source System

{"error":"Invalid Source System."}

400: Bad Request Could not find the subscription

{
   "Code":400,
   "Errors":[
      {
         "Message":"Could not find the subscription.",
         "Code":"Gateway05",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK No response from route check service

{
   "Code":200,
   "Errors":[
      {
         "Message":"No response from route check service.",
         "Code":"RouteCheck",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource": "Genesys"
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK External provider message

{
   "Code":200,
   "Errors":[
      {
         "Message":"External provider message",
         "Code":"RouteCheck",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource": "Genesys"
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Digital only subscriptions cannot update delivery address

{
   "Code":200,
   "Errors":[
      {
         "Message":"Digital only subscriptions cannot update delivery address.",
         "Code":"Address05",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Stopped subscriptions can't update a delivery address

{
   "Code":200,
   "Errors":[
      {
         "Message":"Stopped subscriptions can't update a delivery address.",
         "Code":"Address06",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK International billing addresses can't be changed

{
   "Code":200,
   "Errors":[
      {
         "Message":"International billing addresses can't be changed.",
         "Code":"Address54",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum delivery address changes allowed for date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum delivery address changes allowed for date.",
         "Code":"Address08",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum billing address changes allowed for date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum billing address changes allowed for date.",
         "Code":"Address09",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum address changes allowed for date for both addresses

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum address changes allowed for date for both addresses.",
         "Code":"Address17",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing resume date. The resume date cannot be before than the stop date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing resume date. The resume date cannot be before than the stop date.",
         "Code":"Address38",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The effective date for the delivery address change conflicts with a vacation

{
   "Code":200,
   "Errors":[
      {
         "Message":"The effective date for the delivery address change conflicts with a vacation.",
         "Code":"Address33",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Operation is not allowed because subscription has a permanent stop scheduled at a future date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Operation is not allowed because subscription has a permanent stop scheduled at a future date.",
         "Code":"Address49",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Cannot place a move with pending upgrades or downgrades

{
   "Code":200,
   "Errors":[
      {
         "Message":"Cannot place a move with pending upgrades or downgrades.",
         "Code":"Address48",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The effective date for the delivery address change conflicts with a vacation split

{
   "Code":200,
   "Errors":[
      {
         "Message":"The effective date for the delivery address change conflicts with a vacation split.",
         "Code":"Address50",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any subscription.",
         "Code":"Subscriptions02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription id is invalid. It cannot be null or 0

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription id is invalid. It cannot be null or 0",
         "Code":"Subscriptions16",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{"error":"Authorization is missing."}	

500: Internal Server Error Something went wrong. Please try again later

{"error":"Something went wrong. Please try again later."}

Update Move

PUT /Moves/{Id}

Updates a pending move for a subscription

Path Parameters

Name	Type	Description
*	Integer	Unique identifier of a move in Naviga System

Headers

Name	Type	Description
X-PaperCode*	String
X-MediaGroupCode*	String
X-SourceSystem*	String
Authorization*	String
X-ClientCode*	String

Request Body

Name	Type	Description
AddressChangeType*	Integer	Represents type of movement
ValidateAddress*	Boolean	Indicated if the address should be validated
StopDate*	Datetime	Date in UTC when the address is no longer valid
SubscriptionID*	Integer	Unique identifier of the Subscription in Naviga System
BillingAddress.City*	String	New billing city
BillingAddress.Address*	String	New billing address
ResumeDate	Datetime	Date in UTC when the delivery should be restarted. Required for delivery address updates
BillingAddress.State*	String	New billing state
BillingAddress.PostalCode*	String	New billing postal code
BillingAddress.FirstName*	String	New billing first name
BillingAddress.LastName*	String	New billing last name
BillingAddress.Phone*	String	New phone for billing address

500: Internal Server Error

{
   "Code":500,
   "Errors":[],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

500: Internal Server Error Something went wrong. Please try again later

{
    "error":"Something went wrong. Please try again later."
}

400: Bad Request Could not find the subscription

{
   "Code":400,
   "Errors":[
      {
         "Message":"Could not find the subscription.",
         "Code":"Gateway05",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request X-SourceSystem is missing

{
    "error":"X-SourceSystem is missing."
}

401: Unauthorized Invalid Source System

{
    "error":"Invalid Source System."}
}

401: Unauthorized Invalid authorization

{
    "error":"Invalid authorization."
}

200: OK Move(s) successfully updated

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Done":true,
		"DeliveryAddressStatus": {
			"Status": 0,
			"StatusDescription": "string",
			"MoveId": 0
		},
		"BillingAddressStatus": {
			"Status": 0,
			"StatusDescription": "string",
			"MoveId": 0
		}
	},
	"SessionId": "string",
	"RequestId": "string"
}

200: OK Invalid Input

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid Input.",
         "Code":"Address01",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any move

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any move.",
         "Code":"Address40",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Can't modify a move that will take place today

   "Code":200,
   "Errors":[
      {
         "Message":"Can't modify a move that will take place today.",
         "Code":"Address42",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Address standardization failed

{
   "Code":200,
   "Errors":[
      {
         "Message":"Address standardization failed.",
         "Code":"Address02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The delivery address is not routable

{
   "Code":200,
   "Errors":[
      {
         "Message":"The delivery address is not routable.",
         "Code":"Address11",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription has a pending delivery address move. Can't submit another one

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription has a pending delivery address move. Can't submit another one.",
         "Code":"Address46",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription has a pending billing address move. Can't submit another one

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription has a pending billing address move. Can't submit another one.",
         "Code":"Address47",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing address information. Address, City, State and Postal Code are required

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing address information. Address, City, State and Postal Code are required.",
         "Code":"Address19",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing products

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing products.",
         "Code":"Address24",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not create Delivery Check Event

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not create Delivery Check Event.",
         "Code":"Address13",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not process Delivery Check Event

{
   "Code":200,
   "Errors":[
      {
         "Message":" Could not process Delivery Check Event.",
         "Code":"Address14",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find address for subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find address for subscription.",
         "Code":"Address10",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK No response from route check service

{
   "Code":200,
   "Errors":[
      {
         "Message":"No response from route check service.",
         "Code":"RouteCheck",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource": "Genesys"
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK External provider message

{
   "Code":200,
   "Errors":[
      {
         "Message":"External provider message",
         "Code":"RouteCheck",
         "Type":{
            "Id":2,
            "Code":"Processing"
         },
         "ErrorSource": "Genesys"
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Digital only subscriptions cannot update delivery address

{
   "Code":200,
   "Errors":[
      {
         "Message":"Digital only subscriptions cannot update delivery address.",
         "Code":"Address05",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Stopped subscriptions can't update a delivery address

{
   "Code":200,
   "Errors":[
      {
         "Message":"Stopped subscriptions can't update a delivery address.",
         "Code":"Address06",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK International billing addresses can't be changed

{
   "Code":200,
   "Errors":[
      {
         "Message":"International billing addresses can't be changed.",
         "Code":"Address54",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum delivery address changes allowed for date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum delivery address changes allowed for date.",
         "Code":"Address08",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum billing address changes allowed for date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum billing address changes allowed for date.",
         "Code":"Address09",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Subscription already submitted the maximum address changes allowed for date for both addresses

{
   "Code":200,
   "Errors":[
      {
         "Message":"Subscription already submitted the maximum address changes allowed for date for both addresses.",
         "Code":"Address17",
         "Type":{
            "Id":1,
            "Code":"NotProcessingAllowed"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Invalid or missing resume date. The resume date cannot be before than the stop date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing resume date. The resume date cannot be before than the stop date.",
         "Code":"Address38",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The effective date for the delivery address change conflicts with a vacation

{
   "Code":200,
   "Errors":[
      {
         "Message":"The effective date for the delivery address change conflicts with a vacation.",
         "Code":"Address33",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Operation is not allowed because subscription has a permanent stop scheduled at a future date

{
   "Code":200,
   "Errors":[
      {
         "Message":"Operation is not allowed because subscription has a permanent stop scheduled at a future date.",
         "Code":"Address49",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Cannot place a move with pending upgrades or downgrades

{
   "Code":200,
   "Errors":[
      {
         "Message":"Cannot place a move with pending upgrades or downgrades.",
         "Code":"Address48",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The effective date for the delivery address change conflicts with a vacation split

{
   "Code":200,
   "Errors":[
      {
         "Message":"The effective date for the delivery address change conflicts with a vacation split.",
         "Code":"Address50",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any subscription

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any subscription.",
         "Code":"Subscriptions02",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK The subscription id is invalid. It cannot be null or 0

{
   "Code":200,
   "Errors":[
      {
         "Message":"The subscription id is invalid. It cannot be null or 0",
         "Code":"Subscriptions16",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

Cancel Move

DELETE /Moves/{Id}

Deletes a pending move for a subscription. ID is a unique identifier of a move in Naviga System

Path Parameters

Name	Type	Description
*	Integer	Unique identifier of a move in Naviga System

Headers

Name	Type	Description
Authorization*	String
X-SourceSystem*	String
X-MediaGroupCode*	String
X-ClientCode*	String
X-PaperCode*	String

200: OK Done. Move deleted

{
	"Code": 200,
	"Errors": [],
	"Result": {
		"Done":true
	},
	"SessionId": "string",
	"RequestId": "string"
}
{
   "Code":200,
   "Errors":[
      {
         "Message":"Invalid or missing move id.",
         "Code":"Address39",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Could not find any move

{
   "Code":200,
   "Errors":[
      {
         "Message":"Could not find any move.",
         "Code":"Address40",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK This move does not have any pending transaction

	

{
   "Code":200,
   "Errors":[
      {
         "Message":"This move does not have any pending transaction.",
         "Code":"Address45",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

200: OK Can't cancel a move that will take place today or that already happened

{
   "Code":200,
   "Errors":[
      {
         "Message":"Can't cancel a move that will take place today or that already happened.",
         "Code":"Address41",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Operation is not allowed because subscription has a permanent stop scheduled at a future date

{
   "Code":400,
   "Errors":[
      {
         "Message":"Operation is not allowed because subscription has a permanent stop scheduled at a future date.",
         "Code":"Gateway17",
         "Type":{
            "Id":0,
            "Code":"Validation"
         },
         "ErrorSource":null
      }
   ],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

500: Internal Server Error

{
   "Code":500,
   "Errors":[],
   "Result":null,
   "SessionId":"string",
   "RequestId":"string"
}

400: Bad Request Authorization is missing

{
    "error":"Authorization is missing."
}

400: Bad Request X-SourceSystem is missing

{
    "error":"X-SourceSystem is missing."
}

401: Unauthorized Invalid Source System

{
 "error":"Invalid Source System."
}

401: Unauthorized Invalid authorization

{
    "error":"Invalid authorization."
}

500: Internal Server Error Something went wrong. Please try again later

{
 "error":"Something went wrong. Please try again later."
}