Page tree
Skip to end of metadata
Go to start of metadata

Description

The Outgoing Invoice message is triggered by receipt of an Order Shipped message.

Request

URLURL from associated message destination pipe
ParametersNameTypeRequiredDescriptionIndex  
requestIdStringYUnique message identifier
sourceSystemIdStringYSystem initiating message (MessageDestination.providerCode)
destinationSystemIdStringY

EDGE Merchant identifier (MessageDestination.xRefMerchantId)


messageNameStringYFixed value "OrderImportConfirmation" will be sent
invoiceObjectYContains information about invoice
  • invoiceId
NumberYInternal invoice identifierY
  • invoiceNumber
StringYInvoice numberY
  • invoiceDateTime
DateYDate and time in ISO 8601 format of when the Invoice was isssued 
  • invoiceAmount
NumberYInvoice amount (total)
  • invoiceTax
NumberYInvoice tax amount (total)
orderObject
Contains information about order
  • orderId
NumberYInternal order identifier Y
  • externalReference
StringNAn external reference to this orderY
  • createDateTime
StringNDate and time in ISO 8601 format of when the order was placed
  • currency
StringY

The currency used for this order.

Possible values: "AED", "ALL", "ARS", "AUD", "BAM", "BGN", "BHD", "BOB", "BRL", "BYN", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "DOP", "DZD", "EGP", "EUR", "GBP", "GTQ", "HKD", "HNL", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "ISK", "JOD", "JPY", "KRW", "KWD", "LBP", "LTL", "LVL", "LYD", "MAD", "MKD", "MXN", "MYR", "NIO", "NOK", "NZD", "OMR", "PAB", "PEN", "PHP", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "SAR", "SDG", "SEK", "SGD", "SVC", "SYP", "THB", "TND", "TRY", "TWD", "UAH", "USD", "UYU", "VEF", "VND", "YER", "ZAR"


  • locale
StringY

The locale associated with this order.

Possible values: "ar_AE", "ar_BH", "ar_DZ", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SD", "ar_SY", "ar_TN", "ar_YE", "be_BY", "bg_BG", "ca_ES", "cs_CZ", "da_DK", "de_AT", "de_CH", "de_DE", "de_LU", "el_CY", "el_GR", "en_AU", "en_CA", "en_GB", "en_IE", "en_IN", "en_MT", "en_NZ", "en_PH", "en_SG", "en_US", "en_ZA", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_ES", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PE", "es_PR", "es_PY", "es_SV", "es_US", "es_UY", "es_VE", "et_EE", "fi_FI", "fr_BE", "fr_CA", "fr_CH", "fr_FR", "fr_LU", "ga_IE", "he_IL", "hi_IN", "hr_HR", "hu_HU", "id_ID", "is_IS", "it_CH", "it_IT", "ja_JP", "ko_KR", "lt_LT", "lv_LV", "mk_MK", "ms_MY", "mt_MT", "nl_BE", "nl_NL", "nn_NO", "no_NO", "pl_PL", "pt_BR", "pt_PT", "ro_RO", "ru_RU", "sk_SK", "sl_SI", "sq_AL", "sr_BA", "sr_Latn_BA", "sr_Latn_ME", "sr_ME", "sr_RS", "sv_SE", "th_TH", "tr_TR", "uk_UA", "vi_VN", "zh_CN", "zh_HK", "zh_SG", "zh_TW"


  • notes
StringNNotes to be attached to the order
  • source
StringNThe code of the Marketing Source to be associated with this order. Defined in EDGE Campaigns
  • billingCode
StringNThe name of the Billing Code to associate with this order. Defined in EDGE > System Admin >Merchant > Billing Codes
  • promotions
Array of StringNPromotion codes to apply towards this order. Defined under EDGE Promotions/Rules
  • customer
ObjectYContains information about customer
• • userNameStringN

Username used by the customer


• • emailStringYThe email address associated with the billing address
• • memberTypeStringNCode of this customer's Member Type. Defined in EDGE > System Admin > Customer > Member Types
• • addressObjectYContains information of billing address
• • • firstNameStringYThe first name of the person associated with billing address
• • • lastNameStringYThe last name of the person associated with billing address
• • • middleNameStringNThe middle name of the person associated with billing address
• • • organizationStringNCompany name 
• • • address1StringYFirst part of billing address
• • • address2StringNSecond part of billing address
• • • cityStringYName of city
• • • stateProvinceStringNThe state or province code
• • • postalCodeStringYThe postal code
• • • countryCodeStringYThe country code
• • • isResidentialBooleanN

Pass value true if address is residential, false otherwise. Default: true


 paymentsObject ArrayYArray of objects containing payment information
• • paymentTypeStringY

The payment type for this payment object

Possible values: "CC", "PONUMBER", "ECHECK", "GC", "GIFT_CERTIFICATE", "BILL_ME", "MEMBER_BUDGET", "COD", "CASH", "BUDGET_CENTER", "CHARGES_WAIVED", "CHECKOUT".


• • authorizerCodeStringNThe code of the payment authorizer used to process this payment. Used when payment was processed outside of EDGE and the transaction needs to be stored.
• • amountNumberYAmount for this payment to process.
• • paymentDateTimeStringNDate and time in ISO 8601 format of when the payment was processed. Used when payment was processed outside of EDGE and the transaction needs to be stored.
  • shippingInfo
Object Y

Object containing shipping and fulfillment information.


• • carrierStringNCarrier name (UPS, USPS etc) 
• • serviceStringYCode of the ship method for this shipping info block. Defined under EDGE Logistics
• • addressObjectYContains information of billing address
• • • firstNameStringYThe first name of the person associated with billing address
• • • lastNameStringYThe last name of the person associated with billing address
• • • middleNameStringNThe middle name of the person associated with billing address
• • • organizationStringNCompany name 
• • • address1StringYFirst part of billing address
• • • address2StringNSecond part of billing address
• • • cityStringYName of city
• • • stateProvinceStringNThe state or province code
• • • postalCodeStringYThe postal code
• • • countryCodeStringYThe country code
• • • isResidentialBooleanN

Pass value true if address is residential, false otherwise. Default: true


• itemsObject ArrayYArray of objects containing cart line details
• • catalogStringYCatalog item number value of ordered product
• • skuStringYSKU value of ordered product
• • quantityNumberYQuantity of ordered product
Example
JSON
{
   "invoice": {
      "invoiceId": 548,
      "invoiceNumber": "050003413-1",
      "invoiceDateTime": "2021-04-08T17:13:11.153Z",
      "invoiceAmount": 130,
      "invoiceTax": 0
   },
   "order": {
      "orderId": 50003413,
      "externalReference": "",
      "createDateTime": "2021-03-25T09:55:29.337Z",
      "currency": "USD",
      "locale": "en-US",
      "notes": [],
      "source": "orderCopy",
      "billingCode": "Billing101",
      "promotions": [
         "DJPROMO"
      ],
      "customer": {
         "userName": "vishal",
         "email": "vishalpan@cybage.com",
         "memberType": "Customer",
         "address": {
            "firstName": "Vishal",
            "lastName": "Pandey",
            "middleName": "",
            "organization": "",
            "address1": "32 Campus Dr",
            "address2": "",
            "city": "Missoula",
            "stateProvince": "MT",
            "postalCode": "59812",
            "countryCode": "US"
         }
      },
      "payments": [
         {
            "paymentType": "CC",
            "authorizerCode": "CyberSource",
            "amount": 130,
            "paymentDateTime": "2021-03-25T09:55:28.67Z"
         }
      ],
      "shippingInfo": {
         "carrier": "UPS",
         "service": "UPS GROUND",
         "address": {
            "firstName": "shilpa",
            "lastName": "pandey",
            "middleName": "",
            "organization": "",
            "address1": "200 E University Ave",
            "address2": "",
            "city": "Gainesville",
            "stateProvince": "FL",
            "postalCode": "32601-5456",
            "countryCode": "US",
            "isResidential": false
         }
      },
      "items": [
         {
            "catalog": "Oscar01",
            "sku": "Abyss101Abyss101",
            "quantity": 3
         },
         {
            "catalog": "Avengers62",
            "sku": "Testsku_AJ100.A",
            "quantity": 1
         }
      ]
   },
   "requestId": "101818",
   "sourceSystemId": "OMSJaggedPeakMerchant",
   "destinationSystemId": "WMSTestProvider",
   "messageName": "OutgoingInvoice"
}
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OutgoingInvoiceRequest>
	<RequestId>101818</RequestId>
	<SourceSystemId>OMSJaggedPeakMerchant</SourceSystemId>
	<DestinationSystemId>WMSTestProvider</DestinationSystemId>
	<MessageName>OutgoingInvoice</MessageName>
	<Invoice>
		<InvoiceId>548</InvoiceId>
		<InvoiceNumber>050003413-1</InvoiceNumber>
		<InvoiceDateTime>2021-04-08T17:13:11.153Z</InvoiceDateTime>
		<InvoiceAmount>130.000</InvoiceAmount>
		<InvoiceTax>0.000</InvoiceTax>
	</Invoice>
	<Order>
		<OrderId>50003413</OrderId>
		<ExternalReference/>
		<CreateDateTime>2021-03-25T09:55:29.337Z</CreateDateTime>
		<Currency>USD</Currency>
		<Locale>en-US</Locale>
		<Notes>[]</Notes>
		<Source>orderCopy</Source>
		<BillingCode>Billing101</BillingCode>
		<Promotions>
			<Promotion>DJPROMO</Promotion>
		</Promotions>
		<Customer>
			<UserName>vishal</UserName>
			<Email>vishalpan@cybage.com</Email>
			<MemberType>Customer</MemberType>
			<Address>
				<FirstName>Vishal</FirstName>
				<LastName>Pandey</LastName>
				<MiddleName/>
				<Organization/>
				<Address1>32 Campus Dr</Address1>
				<Address2/>
				<City>Missoula</City>
				<StateProvince>MT</StateProvince>
				<PostalCode>59812</PostalCode>
				<CountryCode>US</CountryCode>
			</Address>
		</Customer>
		<Payments>
			<Payment>
				<PaymentType>CC</PaymentType>
				<AuthorizerCode>CyberSource</AuthorizerCode>
				<Amount>130.0000</Amount>
				<PaymentDateTime>2021-03-25T09:55:28.67Z</PaymentDateTime>
			</Payment>
		</Payments>
		<ShippingInfo>
			<Carrier>UPS</Carrier>
			<Service>UPS GROUND</Service>
			<Address>
				<FirstName>shilpa</FirstName>
				<LastName>pandey</LastName>
				<MiddleName/>
				<Organization/>
				<Address1>200 E University Ave</Address1>
				<Address2/>
				<City>Gainesville</City>
				<StateProvince>FL</StateProvince>
				<PostalCode>32601-5456</PostalCode>
				<CountryCode>US</CountryCode>
				<IsResidential>false</IsResidential>
			</Address>
		</ShippingInfo>
		<Items>
			<Item>
				<Catalog>Oscar01</Catalog>
				<SKU>Abyss101Abyss101</SKU>
				<quantity>3</quantity>
			</Item>
			<Item>
				<Catalog>Avengers62</Catalog>
				<SKU>Testsku_AJ100.A</SKU>
				<quantity>1</quantity>
			</Item>
		</Items>
	</Order>
</OutgoingInvoiceRequest>

Response

ParametersNameTypeDescription
resultCodeStringOK or FAIL
resultMessageStringError description if an request failed
Example
Success
{
	"resultCode":"OK",
	"resultMessage":""
}


Failure
{  
   "resultCode":"FAIL",
   "resultMessage":"Error message here."
}
  • No labels